Duomenų schemos: Tapatybės patvirtinimas

dataTokenData Privalomas

Atsakymo pavyzdys · TokenData.

Pavyzdys: {"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 Privalomas

Atsakymo metaduomenys.

Pavyzdys: {"request_id":"example"}

Papildomi laukai: Ne

dataTokenRevokedData Privalomas

Atsakymo pavyzdys · TokenRevokedData.

Pavyzdys: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Privalomas

Atsakymo metaduomenys.

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

Papildomi laukai: Ne

access_tokenEilutėPrivalomas

Žetonas antraštei Authorization: Bearer. Prieš vykdydami atskirą pavyzdį nustatykite SHOPENTLY_ACCESS_TOKEN.

Pavyzdys: "EXAMPLE_ACCESS_TOKEN"

expires_atEilutėPrivalomas

Galiojimo pabaigos laikas UTC. Dabartiniai prieigos apribojimai gali užblokuoti žetoną anksčiau.

format: "date-time"

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

expires_inSveikasis skaičiusPrivalomas

Tikrasis galiojimo laikas sekundėmis; šiame pavyzdyje prašoma 1800. Užklausos jo nepratęsia. expires_at yra galiojimo pabaiga UTC laiku.

minimum: 300maximum: 3600

Pavyzdys: 1800

permissionsMasyvas <Eilutė> Privalomas

permissions nurodo dabartines veiksmingas teises: API rakto, jo autoriaus ir parduotuvės plano teisių sankirtą, įskaitant aktyvius priedus. Prieiga tikrinama per kiekvieną užklausą.

Pavyzdys: ["orders.order:read"]

rate_limitsTokenRateLimitsData Privalomas

Engine ≥ 4.143.0. Kiekviename žetono atsakyme pateikiami išdavimo metu galiojančios parduotuvės politikos data.rate_limits. Visi raktai dalijasi šiais limitais; naujas žetonas jų neatkuria. Plano pakeitimas gali įsigalioti dar nepasibaigus žetonui.

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

token_typeEilutėNeprivalomas

Bearer. Grąžinto žetono tapatybės patvirtinimo schema.

const: "Bearer"

Numatytoji reikšmė: "Bearer"Pavyzdys: "Bearer"

warningsMasyvas <TokenLifetimeWarning > Privalomas

Sveikasis skaičius už intervalo nustato 900 sekundžių ir grąžina warnings su token.ttl_out_of_range bei documentation_url į learn.shopently.com. Praleistas laukas nesukelia įspėjimo; netinkamas tipas grąžina 422.

Pavyzdys: []

Papildomi laukai: Ne

applied_secondsSveikasis skaičiusNeprivalomas

900 s (15 min)

Numatytoji reikšmė: 900

codeEilutėNeprivalomas

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Numatytoji reikšmė: "token.ttl_out_of_range"

documentation_urlEilutėNeprivalomas

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

Numatytoji reikšmė: "https://learn.shopently.com/en/api/docs/authentication/#token-lifetime"

fieldEilutėNeprivalomas

ttl_seconds

const: "ttl_seconds"

Numatytoji reikšmė: "ttl_seconds"

max_secondsSveikasis skaičiusNeprivalomas

3600 s (60 min)

Numatytoji reikšmė: 3600

messageEilutėNeprivalomas

Sveikasis skaičius už intervalo nustato 900 sekundžių ir grąžina warnings su token.ttl_out_of_range bei documentation_url į learn.shopently.com. Praleistas laukas nesukelia įspėjimo; netinkamas tipas grąžina 422.

Numatytoji reikšmė: "ttl_seconds must be between 300 and 3600 seconds. The default lifetime of 900 seconds was applied."

min_secondsSveikasis skaičiusNeprivalomas

300 s (5 min)

Numatytoji reikšmė: 300

Papildomi laukai: Ne

auth_per_minuteSveikasis skaičiusPrivalomas

Išdavimo ir atšaukimo užklausos per minutę, įskaitant nesėkmingą autentifikavimą. Abi operacijos dalijasi auth limitu.

minimum: 0maximum: 1000000

Pavyzdys: 1

read_per_minuteSveikasis skaičiusPrivalomas

Skaitymo užklausos per minutę.

minimum: 0maximum: 1000000

Pavyzdys: 2

write_per_minuteSveikasis skaičiusPrivalomas

Rašymo užklausos per minutę; ši reikšmė nesuteikia rašymo teisių.

minimum: 0maximum: 1000000

Pavyzdys: 15

Papildomi laukai: Ne

ttl_secondsSveikasis skaičiusNeprivalomas

Neprivalomas sveikasis skaičius ttl_seconds: 300–3600 sekundžių (5–60 minučių). Jei lauko nėra, numatytoji reikšmė yra 900 sekundžių (15 minučių).

Numatytoji reikšmė: 900Pavyzdys: 1800

Papildomi laukai: Ne

access_tokenEilutėPrivalomas

Siųskite POST /api/v1/auth/revoke su išdavusiu API raktu antraštėje Authorization: ApiKey ir prieigos raktu JSON lauke access_token. Po sėkmės kitas naudojimas grąžina 401. Pakartotas, nežinomas ar svetimas raktas gauna tą patį revoked: true; kitų API raktų prieigos raktai neištrinami.

minLength: 1maxLength: 256

Pavyzdys: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Papildomi laukai: Ne

revokedLoginė reikšmėNeprivalomas

Siųskite POST /api/v1/auth/revoke su išdavusiu API raktu antraštėje Authorization: ApiKey ir prieigos raktu JSON lauke access_token. Po sėkmės kitas naudojimas grąžina 401. Pakartotas, nežinomas ar svetimas raktas gauna tą patį revoked: true; kitų API raktų prieigos raktai neištrinami.

const: true

Numatytoji reikšmė: truePavyzdys: true

Papildomi laukai: Ne