Kimlik doğrulama
Kimlik doğrulama
Her istek, Authorization başlığında gizli bir anahtar taşır. Başka bir giriş yolu yoktur ve hiçbir istek oturum çerezi ile doğrulanmaz.
Anahtarlar
Bir anahtar yalnızca oluşturulduğu anda bir kez gösterilir. Onu sunucuların okuyabileceği, tarayıcının okuyamayacağı bir yerde saklayın.
- pc_sk_live_…
- pc_sk_test_…
Test ile canlı ayrı kalır
Kip, parametre olarak geçilmek yerine kimlik bilgisinin kendisine işlenmiştir; bu yüzden bir test anahtarı canlı verileri ne okuyabilir ne de değiştirebilir. Yanlış yönlendirilmiş bir istek, yanlış kataloğa ulaşmak yerine başarısız olur. Test pasaportları, pasaportun kendisinde yapılan son değişiklikten 90 gün sonra silinir.
Anahtarı gönderme
HTTPS üzerinden Bearer kimlik doğrulaması. Başka bir yöntem kabul edilmez ve başlığı taşımayan bir istek herhangi bir kaynağa ulaşmadan reddedilir.
curl "https://passportcraft.com/api/v1/whoami" \
-H "Authorization: Bearer pc_sk_live_…"Tarayıcıdaki kimlik bilgileri bilinçli olarak desteklenmez. Anahtarın yeri sunucudur; ön uç kodundaki bir anahtar, yayımlanmış bir anahtardır.
Kapsamlar
Bir anahtar, oluşturulurken seçilen sabit bir kapsam kümesi taşır. Uç noktasının istediği kapsamı taşımayan bir istek reddedilir ve ret yanıtı eksik olan izni adıyla belirtir.
documents:read
documents:write
filings:write
passports:read
- get
/organizations/{organization}/capabilitiesBu anahtarın bu kuruluş için neler yapabileceğini tanımlar. - get
/organizations/{organization}/passportsPasaportları listeler. - get
/organizations/{organization}/passports/{id}Tek bir pasaportu getirir. - post
/organizations/{organization}/passports/{id}/validateBir pasaportu, kaydetmeden kategori şemasına göre denetler. - get
/organizations/{organization}/passports/{id}/linksHerkese açık URL ile GS1 Digital Link adresini getirir. - get
/organizations/{organization}/passports/{id}/affichageFransız çevresel etiketleme durumunu okur. - get
/organizations/{organization}/importsİçe aktarma işlerini listeler. - get
/organizations/{organization}/imports/{id}Tek bir içe aktarma işini ve ilerlemesini getirir.
passports:write
- post
/organizations/{organization}/passportsBir pasaport oluşturur. - patch
/organizations/{organization}/passports/{id}Bir pasaporta JSON Merge Patch uygular. - post
/organizations/{organization}/passports/{id}/publishBir pasaportu yayımlar. - post
/organizations/{organization}/passports/{id}/unpublishBir pasaportun yayımını geri alır. - post
/organizations/{organization}/passports/{id}/trashBir pasaportu çöp kutusuna taşır. - post
/organizations/{organization}/passports/{id}/restoreBir pasaportu çöp kutusundan geri yükler. - post
/organizations/{organization}/importsEşzamansız toplu içe aktarma başlatır.
units:write
Kapsam gerekmez
Geçerli bir kimlik bilgisi yeterlidir. Bu uç noktalar tek bir kuruluşa ait hiçbir şey döndürmez.