Een API-sleutel beperken (API-toegang)
Elk verkoopkanaal heeft een eigen API-sleutel. Met het blok API-toegang kiest u welke onderdelen van de QrX API die sleutel mag gebruiken, bijvoorbeeld wanneer een partner of een extern systeem alleen voorraad mag lezen.
Waar vindt u het
Ga naar Settings > Business > Merchant Channels, open het verkoopkanaal en kies het tabblad Settings. Het blok API-toegang staat onder de API-sleutel. U hebt het recht Kanalen beheren nodig om het te wijzigen; andere gebruikers kunnen het alleen zien.
Volledige toegang en beperkt
Volledige toegang: de sleutel mag elk onderdeel van de QrX API gebruiken, ook onderdelen die QrX later toevoegt. Elke sleutel begint zo. De uitzondering is het CRM: een CRM-aanroep wordt alleen geaccepteerd als het onderdeel CRM is aangevinkt, dus om de CRM API te gebruiken beperkt u de sleutel en vinkt u het aan (zie hieronder).
Beperkt: de sleutel werkt alleen voor de onderdelen die u hebt aangevinkt. Een aanroep naar een ander onderdeel wordt geweigerd met een 403-fout.
De onderdelen die u kunt aanvinken
Retouren: Retouren lezen (
returns.read), Retouren aanmaken en wijzigen (returns.write), Ontvangen retouren boeken (returns.receiving.write), Bepalen hoe een retour wordt afgehandeld (returns.resolutions.write), Berichten sturen bij een retour (returns.messages.write), Retourwebhooks beheren (returns.webhooks.manage).Inbound: Inbound-leveringen en ontvangsten lezen (
inbound.read), Inbound-leveringen en ontvangsten aanmelden, ontvangen en wijzigen (inbound.write).Voorraad: Voorraadniveaus, artikelen, locaties, mutaties, tellingen en containers lezen (
stock.read), Voorraad aanpassen en artikelen en locaties aanmaken of wijzigen (stock.write).Inkoop: Inkooporders en hun prijzen lezen (
purchasing.read), Inkooporders aanmaken, versturen en afsluiten (purchasing.write).Fulfilment: Picklijsten lezen (
fulfilment.read).Taken: Teamtaken lezen (
tasks.read).CRM: CRM-personen, bedrijven, deals en pijplijnen lezen (
crm.read), CRM-personen, bedrijven, deals en notities aanmaken en wijzigen (crm.write). De CRM-endpoints voor taken en activiteiten gebruiken het leesonderdeel.
De beperking geldt voor deze onderdelen van de API voor retouren, inbound, voorraad en CRM. Transacties, labels en producten aanmaken met de sleutel staat niet in de lijst en blijft werken.
Een sleutel beperken
Zet Deze sleutel beperken aan.
Vink de onderdelen aan die de sleutel mag gebruiken. Vink er minstens één aan.
Klik op API-toegang opslaan. Het blok slaat zelf op.
QrX vraagt Deze API-sleutel beperken? en toont onder Stopt met werken wat de sleutel niet meer kan. Controleer de lijst en klik op De sleutel beperken.
Let op: elk onderdeel dat niet is aangevinkt stopt direct met werken, ook voor integraties die vandaag werken. Een integratie voor retouren of inbound die deze sleutel zonder beperking gebruikte, krijgt een fout zodra haar onderdeel niet is aangevinkt. Onderdelen die QrX later toevoegt staan uit voor een beperkte sleutel totdat u ze aanvinkt.
De vertraging van 30 seconden
Het kan tot 30 seconden duren voordat een wijziging werkt. In die tijd kan een aanroep nog volgens de oude instelling worden geaccepteerd of geweigerd. Wacht een halve minuut voordat u test.
Terug naar volledige toegang
Zet Deze sleutel beperken uit en klik op API-toegang opslaan. De sleutel toont weer Volledige toegang.
Veelgestelde vragen
Mijn integratie krijgt ineens een 403-fout. Wat is er gebeurd?
Iemand heeft de sleutel beperkt en het onderdeel dat uw integratie gebruikt is niet aangevinkt. Voor voorraad is de foutcode STOCK_SCOPE_MISSING. Vink het onderdeel aan, sla op en wacht 30 seconden.
Een CRM-aanroep krijgt een 403-fout met de code CRM_SCOPE_MISSING. Wat nu?
Het onderdeel CRM is niet aangevinkt op de sleutel. Zet Deze sleutel beperken aan, vink CRM aan (lezen, schrijven of beide), sla op en wacht 30 seconden. Zie "CRM Public API".
Verandert beperken de sleutel zelf?
Nee. De sleutel en de toegangstokens blijven gelijk; alleen wat de sleutel mag doen verandert. Om de sleutel zelf te vervangen gebruikt u Regenerate API Key. Zie "Webhooks en API-sleutels in PortalX".
Wanneer neemt u contact op met ons supportteam
Neem contact op met QrX support wanneer een aangevinkt onderdeel meer dan een minuut na het opslaan nog steeds wordt geweigerd. Vermeld het verkoopkanaal, het endpoint en het tijdstip, nooit de sleutel of het token.