Sheme podataka: Autentifikacija

dataTokenData Obvezno

Primjer odgovora · TokenData.

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

Metapodaci odgovora.

Primjer: {"request_id":"example"}

Dodatna polja: Ne

dataTokenRevokedData Obvezno

Primjer odgovora · TokenRevokedData.

Primjer: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obvezno

Metapodaci odgovora.

Primjer: {"request_id":"example-request"}

Dodatna polja: Ne

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:15:00Z"

expires_inCijeli brojObvezno

Stvarno trajanje u sekundama; ovaj primjer traži 1800. Zahtjevi ga ne produljuju. expires_at je vrijeme isteka u UTC-u.

minimum: 300maximum: 3600

Primjer: 1800

permissionsPolje vrijednosti <Niz znakova> Obvezno

permissions navodi trenutačna učinkovita prava: presjek prava ključa, njegova autora i paketa trgovine, uključujući aktivne dodatke. Pristup se provjerava pri svakom zahtjevu.

Primjer: ["orders.order:read"]

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":1,"read_per_minute":2,"write_per_minute":15}

token_typeNiz znakovaNeobavezno

Bearer. Shema autentifikacije za vraćeni token.

const: "Bearer"

Zadano: "Bearer"Primjer: "Bearer"

warningsPolje vrijednosti <TokenLifetimeWarning > Obvezno

Cijeli broj izvan raspona postavlja 900 sekundi i vraća warnings s token.ttl_out_of_range i documentation_url na learn.shopently.com. Izostanak polja ne daje upozorenje; pogrešan tip vraća 422.

Primjer: []

Dodatna polja: Ne

applied_secondsCijeli brojNeobavezno

900 s (15 min)

Zadano: 900

codeNiz znakovaNeobavezno

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Zadano: "token.ttl_out_of_range"

documentation_urlNiz znakovaNeobavezno

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

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

fieldNiz znakovaNeobavezno

ttl_seconds

const: "ttl_seconds"

Zadano: "ttl_seconds"

max_secondsCijeli brojNeobavezno

3600 s (60 min)

Zadano: 3600

messageNiz znakovaNeobavezno

Cijeli broj izvan raspona postavlja 900 sekundi i vraća warnings s token.ttl_out_of_range i documentation_url na learn.shopently.com. Izostanak polja ne daje upozorenje; pogrešan tip vraća 422.

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

min_secondsCijeli brojNeobavezno

300 s (5 min)

Zadano: 300

Dodatna polja: Ne

auth_per_minuteCijeli brojObvezno

Zahtjevi za izdavanje i opoziv tokena u minuti, uključujući neuspjelu autentikaciju. Obje operacije dijele ograničenje auth.

minimum: 0maximum: 1000000

Primjer: 1

read_per_minuteCijeli brojObvezno

Zahtjevi za čitanje u minuti.

minimum: 0maximum: 1000000

Primjer: 2

write_per_minuteCijeli brojObvezno

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

minimum: 0maximum: 1000000

Primjer: 15

Dodatna polja: Ne

ttl_secondsCijeli brojNeobavezno

Neobavezni cijeli broj ttl_seconds: 300–3600 sekundi (5–60 minuta). Bez polja zadano je 900 sekundi (15 minuta).

Zadano: 900Primjer: 1800

Dodatna polja: Ne

access_tokenNiz znakovaObvezno

Pošaljite POST /api/v1/auth/revoke s ključem izdavatelja u Authorization: ApiKey i tokenom u JSON polju access_token. Nakon uspjeha sljedeća uporaba vraća 401. Ponovljeni, nepoznati ili tuđi token vraća isto revoked: true; tokeni drugih ključeva ne brišu se.

minLength: 1maxLength: 256

Primjer: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Dodatna polja: Ne

revokedLogička vrijednostNeobavezno

Pošaljite POST /api/v1/auth/revoke s ključem izdavatelja u Authorization: ApiKey i tokenom u JSON polju access_token. Nakon uspjeha sljedeća uporaba vraća 401. Ponovljeni, nepoznati ili tuđi token vraća isto revoked: true; tokeni drugih ključeva ne brišu se.

const: true

Zadano: truePrimjer: true

Dodatna polja: Ne