Veri şemaları: Kimlik doğrulama

dataTokenData Zorunlu

Yanıt örneği · TokenData.

Örnek: {"access_token":"EXAMPLE_ACCESS_TOKEN","expires_at":"2026-01-01T12:15:00Z","expires_in":1800,"permissions":["orders.order:read"],"rate_limits":{"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15},"token_type":"Bearer","warnings":[]}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Zorunlu

Yanıt üst verileri.

Örnek: {"request_id":"example"}

Ek alanlar: Hayır

dataTokenRevokedData Zorunlu

Yanıt örneği · TokenRevokedData.

Örnek: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Zorunlu

Yanıt üst verileri.

Örnek: {"request_id":"example-request"}

Ek alanlar: Hayır

access_tokenDizeZorunlu

Authorization: Bearer başlığı için token. Ayrı örneği çalıştırmadan önce SHOPENTLY_ACCESS_TOKEN değişkenini ayarlayın.

Örnek: "EXAMPLE_ACCESS_TOKEN"

expires_atDizeZorunlu

UTC olarak sona erme zamanı. Geçerli erişim kısıtlamaları tokenı daha önce engelleyebilir.

format: "date-time"

Örnek: "2026-01-01T12:15:00Z"

expires_inTam sayıZorunlu

Saniye cinsinden gerçek geçerlilik süresi; bu örnek 1800 ister. İstekler süreyi uzatmaz. expires_at UTC bitiş zamanıdır.

minimum: 300maximum: 3600

Örnek: 1800

permissionsDizi <Dize> Zorunlu

permissions geçerli etkin izinleri gösterir: anahtarın, oluşturucusunun ve mağaza planının izinlerinin kesişimi, etkin eklenti izinleri dahil. Erişim her istekte yeniden denetlenir.

Örnek: ["orders.order:read"]

rate_limitsTokenRateLimitsData Zorunlu

Engine ≥ 4.143.0. Her token yanıtı, verildiği anda geçerli mağaza politikasından data.rate_limits içerir. Tüm anahtarlar bu limitleri paylaşır; yeni token limitleri sıfırlamaz. Plan değişikliği token süresi dolmadan uygulanabilir.

Örnek: {"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15}

token_typeDizeİsteğe bağlı

Bearer. Döndürülen belirtecin kimlik doğrulama şeması.

const: "Bearer"

Varsayılan: "Bearer"Örnek: "Bearer"

warningsDizi <TokenLifetimeWarning > Zorunlu

Aralık dışındaki tam sayı 900 saniye uygular; token.ttl_out_of_range ve learn.shopently.com adresine documentation_url içeren warnings döner. Alanın atlanması uyarı üretmez; geçersiz tür 422 döndürür.

Örnek: []

Ek alanlar: Hayır

applied_secondsTam sayıİsteğe bağlı

900 s (15 min)

Varsayılan: 900

codeDizeİsteğe bağlı

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Varsayılan: "token.ttl_out_of_range"

documentation_urlDizeİsteğe bağlı

https://learn.shopently.com/en/api/docs/authentication/#token-lifetime

Varsayılan: "https://learn.shopently.com/en/api/docs/authentication/#token-lifetime"

fieldDizeİsteğe bağlı

ttl_seconds

const: "ttl_seconds"

Varsayılan: "ttl_seconds"

max_secondsTam sayıİsteğe bağlı

3600 s (60 min)

Varsayılan: 3600

messageDizeİsteğe bağlı

Aralık dışındaki tam sayı 900 saniye uygular; token.ttl_out_of_range ve learn.shopently.com adresine documentation_url içeren warnings döner. Alanın atlanması uyarı üretmez; geçersiz tür 422 döndürür.

Varsayılan: "ttl_seconds must be between 300 and 3600 seconds. The default lifetime of 900 seconds was applied."

min_secondsTam sayıİsteğe bağlı

300 s (5 min)

Varsayılan: 300

Ek alanlar: Hayır

auth_per_minuteTam sayıZorunlu

Başarısız kimlik doğrulama dahil, dakikadaki token oluşturma ve iptal istekleri. Her iki işlem auth sınırını paylaşır.

minimum: 0maximum: 1000000

Örnek: 1

read_per_minuteTam sayıZorunlu

Dakika başına okuma isteği.

minimum: 0maximum: 1000000

Örnek: 2

write_per_minuteTam sayıZorunlu

Dakika başına yazma isteği; bu değer yazma yetkisi vermez.

minimum: 0maximum: 1000000

Örnek: 15

Ek alanlar: Hayır

ttl_secondsTam sayıİsteğe bağlı

İsteğe bağlı ttl_seconds tam sayısı: 300–3600 saniye (5–60 dakika). Alan gönderilmezse varsayılan 900 saniyedir (15 dakika).

Varsayılan: 900Örnek: 1800

Ek alanlar: Hayır

access_tokenDizeZorunlu

POST /api/v1/auth/revoke isteğinde tokenı veren anahtarı Authorization: ApiKey başlığında, tokenı JSON access_token alanında gönderin. Başarıdan sonra sonraki kullanım 401 döndürür. Tekrarlanan, bilinmeyen veya başkasına ait token için aynı revoked: true döner; diğer anahtarların tokenları silinmez.

minLength: 1maxLength: 256

Örnek: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Ek alanlar: Hayır

revokedMantıksal değerİsteğe bağlı

POST /api/v1/auth/revoke isteğinde tokenı veren anahtarı Authorization: ApiKey başlığında, tokenı JSON access_token alanında gönderin. Başarıdan sonra sonraki kullanım 401 döndürür. Tekrarlanan, bilinmeyen veya başkasına ait token için aynı revoked: true döner; diğer anahtarların tokenları silinmez.

const: true

Varsayılan: trueÖrnek: true

Ek alanlar: Hayır