Podatkovne sheme: Preverjanje pristnosti

dataTokenData Obvezno

Primer odgovora · TokenData.

Primer: {"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

Metapodatki odgovora.

Primer: {"request_id":"example"}

Dodatna polja: Ne

dataTokenRevokedData Obvezno

Primer odgovora · TokenRevokedData.

Primer: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obvezno

Metapodatki odgovora.

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

Dodatna polja: Ne

access_tokenNizObvezno

Žeton za glavo Authorization: Bearer. Pred zagonom ločenega primera nastavite SHOPENTLY_ACCESS_TOKEN.

Primer: "EXAMPLE_ACCESS_TOKEN"

expires_atNizObvezno

Čas izteka v UTC. Trenutne omejitve dostopa lahko žeton blokirajo prej.

format: "date-time"

Primer: "2026-01-01T12:15:00Z"

expires_inCelo številoObvezno

Dejanska veljavnost v sekundah; ta primer zahteva 1800. Zahteve je ne podaljšajo. expires_at je čas poteka v UTC.

minimum: 300maximum: 3600

Primer: 1800

permissionsPolje elementov <Niz> Obvezno

permissions navaja trenutna učinkovita dovoljenja: presek pravic ključa, njegovega avtorja in paketa trgovine, vključno z aktivnimi dodatki. Dostop se preveri pri vsaki zahtevi.

Primer: ["orders.order:read"]

rate_limitsTokenRateLimitsData Obvezno

Engine ≥ 4.143.0. Vsak odgovor z žetonom vsebuje data.rate_limits iz pravil trgovine ob izdaji. Vsi ključi si delijo te omejitve; nov žeton jih ne ponastavi. Sprememba paketa lahko začne veljati pred potekom žetona.

Primer: {"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15}

token_typeNizIzbirno

Bearer. Shema preverjanja pristnosti vrnjenega žetona.

const: "Bearer"

Privzeto: "Bearer"Primer: "Bearer"

warningsPolje elementov <TokenLifetimeWarning > Obvezno

Celo število zunaj obsega nastavi 900 sekund in vrne warnings s token.ttl_out_of_range ter documentation_url na learn.shopently.com. Manjkajoče polje ne povzroči opozorila; napačna vrsta vrne 422.

Primer: []

Dodatna polja: Ne

applied_secondsCelo številoIzbirno

900 s (15 min)

Privzeto: 900

codeNizIzbirno

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Privzeto: "token.ttl_out_of_range"

documentation_urlNizIzbirno

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

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

fieldNizIzbirno

ttl_seconds

const: "ttl_seconds"

Privzeto: "ttl_seconds"

max_secondsCelo številoIzbirno

3600 s (60 min)

Privzeto: 3600

messageNizIzbirno

Celo število zunaj obsega nastavi 900 sekund in vrne warnings s token.ttl_out_of_range ter documentation_url na learn.shopently.com. Manjkajoče polje ne povzroči opozorila; napačna vrsta vrne 422.

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

min_secondsCelo številoIzbirno

300 s (5 min)

Privzeto: 300

Dodatna polja: Ne

auth_per_minuteCelo številoObvezno

Zahteve za izdajo in preklic žetonov na minuto, vključno z neuspešno avtentikacijo. Obe operaciji delita omejitev auth.

minimum: 0maximum: 1000000

Primer: 1

read_per_minuteCelo številoObvezno

Zahteve za branje na minuto.

minimum: 0maximum: 1000000

Primer: 2

write_per_minuteCelo številoObvezno

Zahteve za pisanje na minuto; ta vrednost ne dodeli pravic pisanja.

minimum: 0maximum: 1000000

Primer: 15

Dodatna polja: Ne

ttl_secondsCelo številoIzbirno

Izbirno celo število ttl_seconds: 300–3600 sekund (5–60 minut). Brez polja je privzeto 900 sekund (15 minut).

Privzeto: 900Primer: 1800

Dodatna polja: Ne

access_tokenNizObvezno

Pošljite POST /api/v1/auth/revoke s ključem izdajatelja v Authorization: ApiKey in žetonom v polju JSON access_token. Po uspehu naslednja uporaba vrne 401. Ponovljen, neznan ali tuj žeton vrne isto revoked: true; žetoni drugih ključev se ne izbrišejo.

minLength: 1maxLength: 256

Primer: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Dodatna polja: Ne

revokedLogična vrednostIzbirno

Pošljite POST /api/v1/auth/revoke s ključem izdajatelja v Authorization: ApiKey in žetonom v polju JSON access_token. Po uspehu naslednja uporaba vrne 401. Ponovljen, neznan ali tuj žeton vrne isto revoked: true; žetoni drugih ključev se ne izbrišejo.

const: true

Privzeto: truePrimer: true

Dodatna polja: Ne