Dátové schémy: Overovanie

dataTokenData Povinné

Príklad odpovede · TokenData.

Príklad: {"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 Povinné

Metaúdaje odpovede.

Príklad: {"request_id":"example"}

Ďalšie polia: Nie

dataTokenRevokedData Povinné

Príklad odpovede · TokenRevokedData.

Príklad: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Povinné

Metaúdaje odpovede.

Príklad: {"request_id":"example-request"}

Ďalšie polia: Nie

access_tokenReťazecPovinné

Token pre hlavičku Authorization: Bearer. Pred samostatným príkladom nastavte SHOPENTLY_ACCESS_TOKEN.

Príklad: "EXAMPLE_ACCESS_TOKEN"

expires_atReťazecPovinné

Okamih vypršania v UTC. Aktuálne obmedzenia prístupu môžu token zablokovať skôr.

format: "date-time"

Príklad: "2026-01-01T12:15:00Z"

expires_inCelé čísloPovinné

Skutočná platnosť v sekundách; tento príklad žiada 1800. Požiadavky ju nepredlžujú. expires_at je čas vypršania v UTC.

minimum: 300maximum: 3600

Príklad: 1800

permissionsPole <Reťazec> Povinné

permissions uvádza aktuálne účinné oprávnenia: prienik oprávnení kľúča, jeho autora a plánu obchodu vrátane aktívnych doplnkov. Prístup sa overuje pri každej požiadavke.

Príklad: ["orders.order:read"]

rate_limitsTokenRateLimitsData Povinné

Engine ≥ 4.143.0. Každá odpoveď s tokenom obsahuje data.rate_limits z pravidiel obchodu platných pri vydaní. Všetky kľúče zdieľajú tieto limity; nový token ich neobnovuje. Zmena programu môže platiť pred vypršaním tokenu.

Príklad: {"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15}

token_typeReťazecVoliteľné

Bearer. Spôsob overenia pre vrátený token.

const: "Bearer"

Predvolená hodnota: "Bearer"Príklad: "Bearer"

warningsPole <TokenLifetimeWarning > Povinné

Celé číslo mimo rozsahu nastaví 900 sekúnd a vráti warnings s token.ttl_out_of_range a documentation_url na learn.shopently.com. Chýbajúce pole nevyvolá upozornenie; nesprávny typ vráti 422.

Príklad: []

Ďalšie polia: Nie

applied_secondsCelé čísloVoliteľné

900 s (15 min)

Predvolená hodnota: 900

codeReťazecVoliteľné

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Predvolená hodnota: "token.ttl_out_of_range"

documentation_urlReťazecVoliteľné

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

Predvolená hodnota: "https://learn.shopently.com/en/api/docs/authentication/#token-lifetime"

fieldReťazecVoliteľné

ttl_seconds

const: "ttl_seconds"

Predvolená hodnota: "ttl_seconds"

max_secondsCelé čísloVoliteľné

3600 s (60 min)

Predvolená hodnota: 3600

messageReťazecVoliteľné

Celé číslo mimo rozsahu nastaví 900 sekúnd a vráti warnings s token.ttl_out_of_range a documentation_url na learn.shopently.com. Chýbajúce pole nevyvolá upozornenie; nesprávny typ vráti 422.

Predvolená hodnota: "ttl_seconds must be between 300 and 3600 seconds. The default lifetime of 900 seconds was applied."

min_secondsCelé čísloVoliteľné

300 s (5 min)

Predvolená hodnota: 300

Ďalšie polia: Nie

auth_per_minuteCelé čísloPovinné

Požiadavky na vydanie a zrušenie tokenu za minútu vrátane neúspešných overení. Obe operácie zdieľajú limit auth.

minimum: 0maximum: 1000000

Príklad: 1

read_per_minuteCelé čísloPovinné

Požiadavky na čítanie za minútu.

minimum: 0maximum: 1000000

Príklad: 2

write_per_minuteCelé čísloPovinné

Požiadavky na zápis za minútu; táto hodnota neudeľuje právo zápisu.

minimum: 0maximum: 1000000

Príklad: 15

Ďalšie polia: Nie

ttl_secondsCelé čísloVoliteľné

Voliteľné celé číslo ttl_seconds: 300–3600 sekúnd (5–60 minút). Bez poľa platí predvolených 900 sekúnd (15 minút).

Predvolená hodnota: 900Príklad: 1800

Ďalšie polia: Nie

access_tokenReťazecPovinné

Pošlite POST /api/v1/auth/revoke s vydávajúcim kľúčom v Authorization: ApiKey a tokenom v poli JSON access_token. Po úspechu ďalšie použitie vráti 401. Opakovaný, neznámy alebo cudzí token vráti rovnaké revoked: true; tokeny iných kľúčov sa nemažú.

minLength: 1maxLength: 256

Príklad: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Ďalšie polia: Nie

revokedLogická hodnotaVoliteľné

Pošlite POST /api/v1/auth/revoke s vydávajúcim kľúčom v Authorization: ApiKey a tokenom v poli JSON access_token. Po úspechu ďalšie použitie vráti 401. Opakovaný, neznámy alebo cudzí token vráti rovnaké revoked: true; tokeny iných kľúčov sa nemažú.

const: true

Predvolená hodnota: truePríklad: true

Ďalšie polia: Nie