Preskočiť na obsah
ShopentlyLearn

Dátové schémy: Overovanie

Dátové schémy: Overovanie. Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.

Dátové schémy

Načítať · Token — Overovanie — Odpoveď

ApiResponse_TokenData_ · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
dataTokenData Povinné

Príklad odpovede · TokenData.

Príklad: {"access_token":"EXAMPLE_ACCESS_TOKEN","expires_at":"2026-01-01T12:00:00Z","expires_in":900,"rate_limits":{"auth_per_minute":10,"read_per_minute":60,"write_per_minute":10},"token_type":"Bearer"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Povinné

Metaúdaje odpovede.

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

Ďalšie polia: Nie

Načítať · Token — Overovanie — Odpoveď

TokenData · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
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:00:00Z"
expires_inCelé čísloVoliteľné

900 sekúnd, teda 15 minút od vydania. Odosielanie požiadaviek platnosť nepredlžuje.

Predvolená hodnota: 900Príklad: 900
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":10,"read_per_minute":60,"write_per_minute":10}
token_typeReťazecVoliteľné

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

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

Ďalšie polia: Nie

Limity požiadaviek

TokenRateLimitsData · 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. Nula znamená nedostupnosť, nie neobmedzenú prevádzku.
auth_per_minuteCelé čísloPovinné

Požiadavky na token za minútu vrátane neúspešných pokusov o overenie.

minimum: 0maximum: 1000000
Príklad: 10
read_per_minuteCelé čísloPovinné

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

minimum: 0maximum: 1000000
Príklad: 60
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: 10

Ďalšie polia: Nie

Načítať · Token — Overovanie — Telo požiadavky

TokenRequest · Polia, typy a obmedzenia údajov prijímaných alebo vracaných API.
ObjektĎalšie polia: Nie

Ďalšie polia: Nie