Adatsémák: Hitelesítés

dataTokenData Kötelező

Példaválasz · TokenData.

Példa: {"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 Kötelező

A válasz metaadatai.

Példa: {"request_id":"example"}

További mezők: Nem

dataTokenRevokedData Kötelező

Példaválasz · TokenRevokedData.

Példa: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Kötelező

A válasz metaadatai.

Példa: {"request_id":"example-request"}

További mezők: Nem

access_tokenKarakterláncKötelező

Token az Authorization: Bearer fejléchez. Az önálló példa futtatása előtt állítsa be a SHOPENTLY_ACCESS_TOKEN változót.

Példa: "EXAMPLE_ACCESS_TOKEN"

expires_atKarakterláncKötelező

A lejárat időpontja UTC szerint. Az aktuális hozzáférési korlátozások korábban is letilthatják a tokent.

format: "date-time"

Példa: "2026-01-01T12:15:00Z"

expires_inEgész számKötelező

Tényleges élettartam másodpercben; ez a példa 1800-at kér. A kérések nem hosszabbítják meg. Az expires_at a lejárat UTC-időpontja.

minimum: 300maximum: 3600

Példa: 1800

permissionsTömb <Karakterlánc> Kötelező

A permissions az aktuális érvényes jogosultságokat sorolja fel: a kulcs, a szerző és az áruházi csomag jogosultságainak metszetét, az aktív bővítményekkel együtt. Minden kérés újra ellenőrzi a hozzáférést.

Példa: ["orders.order:read"]

rate_limitsTokenRateLimitsData Kötelező

Engine ≥ 4.143.0. Minden tokenválasz tartalmazza a kiadáskor érvényes áruházi szabályzat data.rate_limits értékeit. Az összes kulcs közösen használja ezeket a kereteket; új token nem állítja vissza őket. A csomagváltás a token lejárta előtt is érvényesülhet.

Példa: {"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15}

token_typeKarakterláncNem kötelező

Bearer. A visszaadott token hitelesítési sémája.

const: "Bearer"

Alapértelmezett: "Bearer"Példa: "Bearer"

warningsTömb <TokenLifetimeWarning > Kötelező

A tartományon kívüli egész szám 900 másodpercet állít be, és warnings választ ad token.ttl_out_of_range kóddal és a learn.shopently.com oldalra mutató documentation_url mezővel. Hiányzó mezőnél nincs figyelmeztetés; hibás típusnál 422 a válasz.

Példa: []

További mezők: Nem

applied_secondsEgész számNem kötelező

900 s (15 min)

Alapértelmezett: 900

codeKarakterláncNem kötelező

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Alapértelmezett: "token.ttl_out_of_range"

documentation_urlKarakterláncNem kötelező

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

Alapértelmezett: "https://learn.shopently.com/en/api/docs/authentication/#token-lifetime"

fieldKarakterláncNem kötelező

ttl_seconds

const: "ttl_seconds"

Alapértelmezett: "ttl_seconds"

max_secondsEgész számNem kötelező

3600 s (60 min)

Alapértelmezett: 3600

messageKarakterláncNem kötelező

A tartományon kívüli egész szám 900 másodpercet állít be, és warnings választ ad token.ttl_out_of_range kóddal és a learn.shopently.com oldalra mutató documentation_url mezővel. Hiányzó mezőnél nincs figyelmeztetés; hibás típusnál 422 a válasz.

Alapértelmezett: "ttl_seconds must be between 300 and 3600 seconds. The default lifetime of 900 seconds was applied."

min_secondsEgész számNem kötelező

300 s (5 min)

Alapértelmezett: 300

További mezők: Nem

auth_per_minuteEgész számKötelező

Tokenkiadási és visszavonási kérések percenként, a sikertelen hitelesítésekkel együtt. Mindkét művelet a közös auth keretet használja.

minimum: 0maximum: 1000000

Példa: 1

read_per_minuteEgész számKötelező

Olvasási kérések percenként.

minimum: 0maximum: 1000000

Példa: 2

write_per_minuteEgész számKötelező

Írási kérések percenként; ez az érték nem ad írási jogosultságot.

minimum: 0maximum: 1000000

Példa: 15

További mezők: Nem

ttl_secondsEgész számNem kötelező

Opcionális egész szám, ttl_seconds: 300–3600 másodperc (5–60 perc). Ha hiányzik, az alapérték 900 másodperc (15 perc).

Alapértelmezett: 900Példa: 1800

További mezők: Nem

access_tokenKarakterláncKötelező

Küldj POST /api/v1/auth/revoke kérést a kiadó kulccsal az Authorization: ApiKey fejlécben és a tokennel az access_token JSON-mezőben. Siker után a következő használat 401-et ad. Ismételt, ismeretlen vagy idegen tokennél is revoked: true a válasz; más kulcsok tokenjei nem törlődnek.

minLength: 1maxLength: 256

Példa: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

További mezők: Nem

revokedLogikai értékNem kötelező

Küldj POST /api/v1/auth/revoke kérést a kiadó kulccsal az Authorization: ApiKey fejlécben és a tokennel az access_token JSON-mezőben. Siker után a következő használat 401-et ad. Ismételt, ismeretlen vagy idegen tokennél is revoked: true a válasz; más kulcsok tokenjei nem törlődnek.

const: true

Alapértelmezett: truePélda: true

További mezők: Nem