Authentifizierung
Authentifizierung
Jede Anfrage führt einen geheimen Schlüssel im Authorization-Header mit. Einen anderen Weg hinein gibt es nicht, und keine Anfrage wird jemals über ein Sitzungs-Cookie authentifiziert.
Schlüssel
Ein Schlüssel wird genau einmal angezeigt, im Moment seiner Erzeugung. Bewahren Sie ihn dort auf, wo die Server ihn lesen können und ein Browser nicht.
- pc_sk_live_…
- pc_sk_test_…
Test und Live bleiben getrennt
Der Modus steckt im Zugangsschlüssel selbst und wird nicht als Parameter übergeben. Ein Test-Schlüssel kann Live-Daten daher weder lesen noch ändern: eine fehlgeleitete Anfrage scheitert, statt im falschen Katalog zu landen. Test-Produktpässe werden 90 Tage nach der letzten Änderung am Pass selbst gelöscht.
Den Schlüssel senden
Bearer-Authentifizierung über HTTPS. Etwas anderes wird nicht akzeptiert, und eine Anfrage ohne den Header wird abgelehnt, bevor sie irgendeine Ressource erreicht.
curl "https://passportcraft.com/api/v1/whoami" \
-H "Authorization: Bearer pc_sk_live_…"Zugangsdaten im Browser werden bewusst nicht unterstützt. Ein Schlüssel gehört auf einen Server, und ein Schlüssel im Frontend-Code ist ein veröffentlichter Schlüssel.
Scopes
Ein Schlüssel trägt eine feste Menge an Scopes, die bei seiner Erzeugung gewählt wird. Eine Anfrage ohne den vom Endpunkt verlangten Scope wird abgelehnt, und die Ablehnung benennt die fehlende Berechtigung.
documents:read
documents:write
filings:write
passports:read
- get
/organizations/{organization}/capabilitiesBeschreiben, was dieser Schlüssel für diese Organisation tun darf. - get
/organizations/{organization}/passportsProduktpässe auflisten. - get
/organizations/{organization}/passports/{id}Einen Produktpass abrufen. - post
/organizations/{organization}/passports/{id}/validateEinen Produktpass gegen sein Kategorieschema prüfen, ohne zu speichern. - get
/organizations/{organization}/passports/{id}/linksDie öffentliche URL und den GS1 Digital Link abrufen. - get
/organizations/{organization}/passports/{id}/affichageDen Stand der französischen Umweltkennzeichnung lesen. - get
/organizations/{organization}/importsImportaufträge auflisten. - get
/organizations/{organization}/imports/{id}Einen Importauftrag samt Fortschritt abrufen.
passports:write
- post
/organizations/{organization}/passportsEinen Produktpass erstellen. - patch
/organizations/{organization}/passports/{id}Einen JSON Merge Patch auf einen Produktpass anwenden. - post
/organizations/{organization}/passports/{id}/publishEinen Produktpass veröffentlichen. - post
/organizations/{organization}/passports/{id}/unpublishEinen Produktpass zurückziehen. - post
/organizations/{organization}/passports/{id}/trashEinen Produktpass in den Papierkorb verschieben. - post
/organizations/{organization}/passports/{id}/restoreEinen Produktpass aus dem Papierkorb wiederherstellen. - post
/organizations/{organization}/importsEinen asynchronen Massenimport starten.
Kein Scope erforderlich
Ein gültiger Zugangsschlüssel genügt. Diese Endpunkte geben nichts zurück, was zu einer einzelnen Organisation gehört.