Autenticazione
Autenticazione
Ogni richiesta porta una chiave segreta nell'intestazione Authorization. Non esiste altra via d'ingresso e nessuna richiesta viene mai autenticata da un cookie di sessione.
Chiavi
Una chiave viene mostrata una sola volta, nel momento in cui viene creata. La conservi dove i server possono leggerla e un browser no.
- pc_sk_live_…
- pc_sk_test_…
Prova e produzione restano separate
Il modo è iscritto nella credenziale stessa anziché passato come parametro, perciò una chiave di prova non può né leggere né modificare dati reali. Una richiesta mal indirizzata fallisce invece di raggiungere il catalogo sbagliato. I passaporti di prova vengono eliminati 90 giorni dopo l'ultima modifica del passaporto stesso.
Inviare la chiave
Autenticazione Bearer su HTTPS. Nient'altro viene accettato, e una richiesta priva dell'intestazione viene rifiutata prima di raggiungere qualsiasi risorsa.
curl "https://passportcraft.com/api/v1/whoami" \
-H "Authorization: Bearer pc_sk_live_…"Le credenziali nel browser non sono supportate, e non lo sono per scelta. Una chiave vive su un server; una chiave nel codice front-end è una chiave già pubblicata.
Ambiti
Una chiave porta un insieme fisso di ambiti, scelto al momento della creazione. Una richiesta priva dell'ambito richiesto dal proprio endpoint viene rifiutata, e il rifiuto nomina il permesso mancante.
documents:read
documents:write
passports:read
- get
/organizations/{organization}/capabilitiesDescrivere che cosa questa chiave può fare per questa organizzazione. - get
/organizations/{organization}/passportsElencare i passaporti. - get
/organizations/{organization}/passports/{id}Recuperare un passaporto. - post
/organizations/{organization}/passports/{id}/validateVerificare un passaporto rispetto allo schema della sua categoria, senza salvare. - get
/organizations/{organization}/passports/{id}/linksRecuperare l’URL pubblico e il GS1 Digital Link. - get
/organizations/{organization}/passports/{id}/affichageLeggere lo stato dell’etichettatura ambientale francese. - get
/organizations/{organization}/importsElencare i lavori di importazione. - get
/organizations/{organization}/imports/{id}Recuperare un lavoro di importazione e il suo avanzamento.
passports:write
- post
/organizations/{organization}/passportsCreare un passaporto. - patch
/organizations/{organization}/passports/{id}Applicare un JSON Merge Patch a un passaporto. - post
/organizations/{organization}/passports/{id}/publishPubblicare un passaporto. - post
/organizations/{organization}/passports/{id}/unpublishRitirare un passaporto. - post
/organizations/{organization}/passports/{id}/trashSpostare un passaporto nel cestino. - post
/organizations/{organization}/passports/{id}/restoreRipristinare un passaporto dal cestino. - post
/organizations/{organization}/importsAvviare un’importazione massiva asincrona.
Nessun ambito richiesto
Basta una credenziale valida. Questi endpoint non restituiscono nulla che appartenga a una singola organizzazione.