Datová schémata: Ověřování

Datová schémata: Ověřování. Pole, typy a omezení dat přijímaných nebo vracených API.

Datová schémata

Načíst · Token — Ověřování — Odpověď

ApiResponse_TokenData_ · Pole, typy a omezení dat přijímaných nebo vracených API.

dataTokenData Povinné: Příklad odpovědi · TokenData.

Pří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é: Metadata odpovědi.

Příklad: {"request_id":"example"}

Další pole: Ne

Načíst · Token — Ověřování — Odpověď

TokenData · Pole, typy a omezení dat přijímaných nebo vracených API.

access_tokenŘetězecPovinné: Token pro hlavičku Authorization: Bearer. Před samostatným příkladem nastavte SHOPENTLY_ACCESS_TOKEN.

Příklad: "EXAMPLE_ACCESS_TOKEN"
expires_atŘetězecPovinné: Okamžik vypršení v UTC. Aktuální omezení přístupu mohou token zablokovat dříve.

format: "date-time"

Příklad: "2026-01-01T12:00:00Z"
expires_inCelé čísloVolitelné: 900 sekund, tedy 15 minut od vydání. Odesílání požadavků platnost neprodlužuje.

Výchozí hodnota: 900Příklad: 900
rate_limitsTokenRateLimitsData Povinné: Engine ≥ 4.143.0. Každá odpověď s tokenem obsahuje data.rate_limits z pravidel obchodu platných při vydání. Všechny klíče sdílejí tyto limity; nový token je neobnovuje. Změna tarifu může platit před vypršením tokenu.

Příklad: {"auth_per_minute":10,"read_per_minute":60,"write_per_minute":10}
token_typeŘetězecVolitelné: Bearer. Způsob ověření pro vrácený token.

const: "Bearer"

Výchozí hodnota: "Bearer"Příklad: "Bearer"

Další pole: Ne

Limity požadavků

TokenRateLimitsData · Engine ≥ 4.143.0. Každá odpověď s tokenem obsahuje data.rate_limits z pravidel obchodu platných při vydání. Všechny klíče sdílejí tyto limity; nový token je neobnovuje. Změna tarifu může platit před vypršením tokenu. Nula znamená nedostupnost, nikoli neomezený provoz.

auth_per_minuteCelé čísloPovinné: Požadavky na token za minutu, včetně neúspěšných pokusů o ověření.

minimum: 0maximum: 1000000

Příklad: 10
read_per_minuteCelé čísloPovinné: Požadavky na čtení za minutu.

minimum: 0maximum: 1000000

Příklad: 60
write_per_minuteCelé čísloPovinné: Požadavky na zápis za minutu; tato hodnota neuděluje právo zápisu.

minimum: 0maximum: 1000000

Příklad: 10

Další pole: Ne

Načíst · Token — Ověřování — Tělo požadavku

TokenRequest · Pole, typy a omezení dat přijímaných nebo vracených API.

ObjektDalší pole: Ne

Další pole: Ne