Einen API-Schlüssel einschränken (API-Zugriff)
Jeder Vertriebskanal hat einen eigenen API-Schlüssel. Mit dem Block API-Zugriff wählen Sie, welche Teile der QrX API dieser Schlüssel nutzen darf, zum Beispiel wenn ein Partner oder ein externes System nur den Bestand lesen soll.
Wo Sie es finden
Gehen Sie zu Settings > Business > Merchant Channels, öffnen Sie den Vertriebskanal und wählen Sie die Registerkarte Settings. Der Block API-Zugriff steht unter dem API-Schlüssel. Zum Ändern benötigen Sie die Berechtigung Kanäle verwalten; andere Benutzer können ihn nur sehen.
Vollzugriff und eingeschränkt
Vollzugriff: Der Schlüssel darf jeden Teil der QrX API nutzen, auch Teile, die QrX später hinzufügt. Jeder Schlüssel beginnt so. Die Ausnahme ist das CRM: Ein CRM-Aufruf wird nur akzeptiert, wenn der Teil CRM angehakt ist. Um die CRM-API zu nutzen, schränken Sie den Schlüssel also ein und haken ihn an (siehe unten).
Eingeschränkt: Der Schlüssel funktioniert nur für die Teile, die Sie angehakt haben. Ein Aufruf eines anderen Teils wird mit einem 403-Fehler abgelehnt.
Die Teile, die Sie anhaken können
Rücksendungen: Rücksendungen lesen (
returns.read), Rücksendungen anlegen und ändern (returns.write), Eingegangene Rücksendungen buchen (returns.receiving.write), Entscheiden, wie eine Rücksendung abgeschlossen wird (returns.resolutions.write), Nachrichten zu einer Rücksendung senden (returns.messages.write), Rücksendungs-Webhooks verwalten (returns.webhooks.manage).Wareneingang: Eingehende Lieferungen und Wareneingänge lesen (
inbound.read), Eingehende Lieferungen und Wareneingänge ankündigen, annehmen und ändern (inbound.write).Bestand: Bestände, Artikel, Lagerplätze, Bewegungen, Inventuren und Ladungsträger lesen (
stock.read), Bestand anpassen sowie Artikel und Lagerplätze anlegen oder ändern (stock.write).Einkauf: Bestellungen und ihre Preise lesen (
purchasing.read), Bestellungen anlegen, senden und abschließen (purchasing.write).Fulfillment: Picklisten lesen (
fulfilment.read).Aufgaben: Teamaufgaben lesen (
tasks.read).CRM: CRM-Personen, Unternehmen, Deals und Pipelines lesen (
crm.read), CRM-Personen, Unternehmen, Deals und Notizen erstellen und ändern (crm.write). Die CRM-Endpunkte für Aufgaben und Aktivitäten nutzen den Lese-Teil.
Die Einschränkung gilt für diese Teile der API für Retouren, Wareneingang, Bestand und CRM. Transaktionen, Etiketten und Produkte mit dem Schlüssel anzulegen steht nicht in der Liste und funktioniert weiter.
Einen Schlüssel einschränken
Schalten Sie Diesen Schlüssel einschränken ein.
Haken Sie die Teile an, die der Schlüssel nutzen darf. Haken Sie mindestens einen an.
Klicken Sie auf API-Zugriff speichern. Der Block speichert für sich.
QrX fragt Diesen API-Schlüssel einschränken? und listet unter Funktioniert nicht mehr, was der Schlüssel nicht mehr kann. Prüfen Sie die Liste und klicken Sie auf Schlüssel einschränken.
Vorsicht: Jeder Teil, der nicht angehakt ist, funktioniert sofort nicht mehr, auch für Integrationen, die heute funktionieren. Eine Integration für Retouren oder Wareneingang, die diesen Schlüssel ohne Einschränkung genutzt hat, erhält einen Fehler, sobald ihr Teil nicht angehakt ist. Teile, die QrX später hinzufügt, sind für einen eingeschränkten Schlüssel aus, bis Sie sie anhaken.
Die Verzögerung von 30 Sekunden
Es kann bis zu 30 Sekunden dauern, bis eine Änderung wirkt. In dieser Zeit kann ein Aufruf noch nach der alten Einstellung angenommen oder abgelehnt werden. Warten Sie eine halbe Minute, bevor Sie testen.
Zurück zum Vollzugriff
Schalten Sie Diesen Schlüssel einschränken aus und klicken Sie auf API-Zugriff speichern. Der Schlüssel zeigt wieder Vollzugriff.
Häufige Fragen
Meine Integration erhält plötzlich einen 403-Fehler. Was ist passiert?
Jemand hat den Schlüssel eingeschränkt, und der Teil, den Ihre Integration nutzt, ist nicht angehakt. Für den Bestand lautet der Fehlercode STOCK_SCOPE_MISSING. Haken Sie den Teil an, speichern Sie und warten Sie 30 Sekunden.
Ein CRM-Aufruf erhält einen 403-Fehler mit dem Code CRM_SCOPE_MISSING. Was nun?
Der Teil CRM ist beim Schlüssel nicht angehakt. Schalten Sie Diesen Schlüssel einschränken ein, haken Sie CRM an (lesen, schreiben oder beides), speichern Sie und warten Sie 30 Sekunden. Siehe "CRM Public API".
Ändert das Einschränken den Schlüssel selbst?
Nein. Der Schlüssel und seine Zugriffstoken bleiben gleich; es ändert sich nur, was der Schlüssel darf. Um den Schlüssel selbst zu ersetzen, verwenden Sie Regenerate API Key. Siehe "Webhooks und API-Schlüssel in PortalX".
Wann Sie unser Support-Team kontaktieren sollten
Kontaktieren Sie den QrX-Support, wenn ein angehakter Teil mehr als eine Minute nach dem Speichern noch immer abgelehnt wird. Nennen Sie den Vertriebskanal, den Endpunkt und den Zeitpunkt, nie den Schlüssel oder das Token.