Scheme de date: Autentificare

dataTokenData Obligatoriu

Exemplu de răspuns · TokenData.

Exemplu: {"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 Obligatoriu

Metadatele răspunsului.

Exemplu: {"request_id":"example"}

Câmpuri suplimentare: Nu

dataTokenRevokedData Obligatoriu

Exemplu de răspuns · TokenRevokedData.

Exemplu: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Obligatoriu

Metadatele răspunsului.

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

Câmpuri suplimentare: Nu

access_tokenȘir de caractereObligatoriu

Token pentru antetul Authorization: Bearer. Setează SHOPENTLY_ACCESS_TOKEN înainte de a rula exemplul separat.

Exemplu: "EXAMPLE_ACCESS_TOKEN"

expires_atȘir de caractereObligatoriu

Momentul expirării în UTC. Restricțiile de acces actuale pot bloca tokenul mai devreme.

format: "date-time"

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

expires_inNumăr întregObligatoriu

Durata reală în secunde; acest exemplu solicită 1800. Cererile nu o prelungesc. expires_at indică expirarea în UTC.

minimum: 300maximum: 3600

Exemplu: 1800

permissionsTablou <Șir de caractere> Obligatoriu

permissions indică permisiunile efective actuale: intersecția permisiunilor cheii, autorului și planului magazinului, inclusiv extensiile active. Accesul se verifică la fiecare cerere.

Exemplu: ["orders.order:read"]

rate_limitsTokenRateLimitsData Obligatoriu

Engine ≥ 4.143.0. Fiecare răspuns cu token include data.rate_limits din politica magazinului la emitere. Toate cheile partajează aceste limite; un token nou nu le resetează. Schimbarea planului se poate aplica înainte de expirarea tokenului.

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

token_typeȘir de caractereOpțional

Bearer. Schema de autentificare pentru tokenul returnat.

const: "Bearer"

Valoare implicită: "Bearer"Exemplu: "Bearer"

warningsTablou <TokenLifetimeWarning > Obligatoriu

Un întreg în afara intervalului aplică 900 de secunde și returnează warnings cu token.ttl_out_of_range și documentation_url către learn.shopently.com. Lipsa câmpului nu produce avertismente; tipurile greșite returnează 422.

Exemplu: []

Câmpuri suplimentare: Nu

applied_secondsNumăr întregOpțional

900 s (15 min)

Valoare implicită: 900

codeȘir de caractereOpțional

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Valoare implicită: "token.ttl_out_of_range"

documentation_urlȘir de caractereOpțional

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

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

fieldȘir de caractereOpțional

ttl_seconds

const: "ttl_seconds"

Valoare implicită: "ttl_seconds"

max_secondsNumăr întregOpțional

3600 s (60 min)

Valoare implicită: 3600

messageȘir de caractereOpțional

Un întreg în afara intervalului aplică 900 de secunde și returnează warnings cu token.ttl_out_of_range și documentation_url către learn.shopently.com. Lipsa câmpului nu produce avertismente; tipurile greșite returnează 422.

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

min_secondsNumăr întregOpțional

300 s (5 min)

Valoare implicită: 300

Câmpuri suplimentare: Nu

auth_per_minuteNumăr întregObligatoriu

Cereri de emitere și revocare pe minut, inclusiv autentificările eșuate. Ambele operații folosesc același buget auth.

minimum: 0maximum: 1000000

Exemplu: 1

read_per_minuteNumăr întregObligatoriu

Cereri de citire pe minut.

minimum: 0maximum: 1000000

Exemplu: 2

write_per_minuteNumăr întregObligatoriu

Cereri de scriere pe minut; această valoare nu acordă drepturi de scriere.

minimum: 0maximum: 1000000

Exemplu: 15

Câmpuri suplimentare: Nu

ttl_secondsNumăr întregOpțional

Număr întreg opțional ttl_seconds: 300–3600 secunde (5–60 minute). Dacă lipsește, valoarea implicită este 900 de secunde (15 minute).

Valoare implicită: 900Exemplu: 1800

Câmpuri suplimentare: Nu

access_tokenȘir de caractereObligatoriu

Trimite POST /api/v1/auth/revoke cu cheia emitentă în Authorization: ApiKey și tokenul în câmpul JSON access_token. După succes, următoarea utilizare returnează 401. Tokenurile repetate, necunoscute sau străine primesc același revoked: true; tokenurile altor chei nu sunt șterse.

minLength: 1maxLength: 256

Exemplu: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Câmpuri suplimentare: Nu

revokedValoare booleanăOpțional

Trimite POST /api/v1/auth/revoke cu cheia emitentă în Authorization: ApiKey și tokenul în câmpul JSON access_token. După succes, următoarea utilizare returnează 401. Tokenurile repetate, necunoscute sau străine primesc același revoked: true; tokenurile altor chei nu sunt șterse.

const: true

Valoare implicită: trueExemplu: true

Câmpuri suplimentare: Nu