Preskoči na sadržaj
ShopentlyLearn

Sheme podataka: Autentifikacija

Sheme podataka: Autentifikacija. Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.

Sheme podataka

Dohvati · Token — Autentifikacija — Odgovor

ApiResponse_TokenData_ · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
dataTokenData Obvezno

Primjer odgovora · TokenData.

Primjer: {"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 Obvezno

Metapodaci odgovora.

Primjer: {"request_id":"example"}

Dodatna polja: Ne

Dohvati · Token — Autentifikacija — Odgovor

TokenData · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
access_tokenNiz znakovaObvezno

Token za zaglavlje Authorization: Bearer. Postavite SHOPENTLY_ACCESS_TOKEN prije pokretanja zasebnog primjera.

Primjer: "EXAMPLE_ACCESS_TOKEN"
expires_atNiz znakovaObvezno

Vrijeme isteka u UTC-u. Trenutačna ograničenja pristupa mogu blokirati token ranije.

format: "date-time"
Primjer: "2026-01-01T12:00:00Z"
expires_inCijeli brojNeobavezno

900 sekundi, odnosno 15 minuta od izdavanja. Slanje zahtjeva ne produljuje valjanost.

Zadano: 900Primjer: 900
rate_limitsTokenRateLimitsData Obvezno

Engine ≥ 4.143.0. Svaki odgovor s tokenom sadrži data.rate_limits iz pravila trgovine pri izdavanju. Svi ključevi dijele te limite; novi token ih ne obnavlja. Promjena plana može se primijeniti prije isteka tokena.

Primjer: {"auth_per_minute":10,"read_per_minute":60,"write_per_minute":10}
token_typeNiz znakovaNeobavezno

Bearer. Shema autentifikacije za vraćeni token.

const: "Bearer"
Zadano: "Bearer"Primjer: "Bearer"

Dodatna polja: Ne

Ograničenja učestalosti

TokenRateLimitsData · Engine ≥ 4.143.0. Svaki odgovor s tokenom sadrži data.rate_limits iz pravila trgovine pri izdavanju. Svi ključevi dijele te limite; novi token ih ne obnavlja. Promjena plana može se primijeniti prije isteka tokena. Nula znači nedostupnost, a ne neograničeno korištenje.
auth_per_minuteCijeli brojObvezno

Zahtjevi za token u minuti, uključujući neuspjele pokušaje autentifikacije.

minimum: 0maximum: 1000000
Primjer: 10
read_per_minuteCijeli brojObvezno

Zahtjevi za čitanje u minuti.

minimum: 0maximum: 1000000
Primjer: 60
write_per_minuteCijeli brojObvezno

Zahtjevi za pisanje u minuti; ta vrijednost ne daje prava pisanja.

minimum: 0maximum: 1000000
Primjer: 10

Dodatna polja: Ne

Dohvati · Token — Autentifikacija — Tijelo zahtjeva

TokenRequest · Polja, vrste i ograničenja podataka koje API prihvaća ili vraća.
ObjektDodatna polja: Ne

Dodatna polja: Ne