Authenticatie
Authenticatie
Elk verzoek draagt een geheime sleutel in de Authorization-header. Een andere ingang is er niet, en geen enkel verzoek wordt ooit via een sessiecookie geauthenticeerd.
Sleutels
Een sleutel wordt één keer getoond, op het moment van aanmaken. Bewaar hem waar de servers hem kunnen lezen en een browser niet.
- pc_sk_live_…
- pc_sk_test_…
Test en productie blijven gescheiden
De modus zit in de sleutel zelf en wordt niet als parameter meegegeven, dus een testsleutel kan productiegegevens noch lezen noch wijzigen. Een verkeerd geadresseerd verzoek mislukt in plaats van in de verkeerde catalogus terecht te komen. Testpaspoorten worden 90 dagen na de laatste wijziging aan het paspoort zelf verwijderd.
De sleutel meesturen
Bearer-authenticatie over HTTPS. Iets anders wordt niet geaccepteerd, en een verzoek zonder de header wordt geweigerd voordat het enige bron bereikt.
curl "https://passportcraft.com/api/v1/whoami" \
-H "Authorization: Bearer pc_sk_live_…"Inloggegevens in de browser worden bewust niet ondersteund. Een sleutel hoort op een server; een sleutel in front-endcode is een gepubliceerde sleutel.
Scopes
Een sleutel draagt een vaste verzameling scopes, gekozen bij het aanmaken. Een verzoek zonder de scope die het endpoint verlangt wordt geweigerd, en de weigering noemt de ontbrekende toestemming.
documents:read
documents:write
filings:write
passports:read
- get
/organizations/{organization}/capabilitiesBeschrijven wat deze sleutel voor deze organisatie mag doen. - get
/organizations/{organization}/passportsPaspoorten opsommen. - get
/organizations/{organization}/passports/{id}Eén paspoort ophalen. - post
/organizations/{organization}/passports/{id}/validateEen paspoort tegen het schema van zijn categorie controleren zonder op te slaan. - get
/organizations/{organization}/passports/{id}/linksDe openbare URL en de GS1 Digital Link ophalen. - get
/organizations/{organization}/passports/{id}/affichageDe stand van de Franse milieuaanduiding lezen. - get
/organizations/{organization}/importsImporttaken opsommen. - get
/organizations/{organization}/imports/{id}Eén importtaak en de voortgang ervan ophalen.
passports:write
- post
/organizations/{organization}/passportsEen paspoort aanmaken. - patch
/organizations/{organization}/passports/{id}Een JSON Merge Patch op een paspoort toepassen. - post
/organizations/{organization}/passports/{id}/publishEen paspoort publiceren. - post
/organizations/{organization}/passports/{id}/unpublishEen paspoort terugtrekken. - post
/organizations/{organization}/passports/{id}/trashEen paspoort naar de prullenbak verplaatsen. - post
/organizations/{organization}/passports/{id}/restoreEen paspoort uit de prullenbak herstellen. - post
/organizations/{organization}/importsEen asynchrone bulkimport starten.
Geen scope vereist
Een geldige sleutel volstaat. Deze endpoints geven niets terug dat bij één organisatie hoort.