Andmeskeemid: Autentimine

dataTokenData Kohustuslik

Vastuse näide · TokenData.

Näide: {"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 Kohustuslik

Vastuse metaandmed.

Näide: {"request_id":"example"}

Lisaväljad: Ei

dataTokenRevokedData Kohustuslik

Vastuse näide · TokenRevokedData.

Näide: {"revoked":true}

metaContextPageMeta | ContextMeta | PageMeta | RequestMeta Kohustuslik

Vastuse metaandmed.

Näide: {"request_id":"example-request"}

Lisaväljad: Ei

access_tokenStringKohustuslik

Token päise Authorization: Bearer jaoks. Enne eraldi näite käivitamist määra SHOPENTLY_ACCESS_TOKEN.

Näide: "EXAMPLE_ACCESS_TOKEN"

expires_atStringKohustuslik

Aegumisaeg UTC-s. Kehtivad juurdepääsupiirangud võivad tokeni varem blokeerida.

format: "date-time"

Näide: "2026-01-01T12:15:00Z"

expires_inTäisarvKohustuslik

Tegelik kehtivusaeg sekundites; see näide taotleb 1800. Päringud seda ei pikenda. expires_at näitab aegumist UTC-s.

minimum: 300maximum: 3600

Näide: 1800

permissionsMassiiv <String> Kohustuslik

permissions näitab praegusi kehtivaid õigusi: võtme, selle looja ja poe paketi õiguste ühisosa koos aktiivsete lisadega. Ligipääsu kontrollitakse iga päringu puhul.

Näide: ["orders.order:read"]

rate_limitsTokenRateLimitsData Kohustuslik

Engine ≥ 4.143.0. Iga tokenivastus sisaldab väljastamise hetkel kehtiva poepoliitika data.rate_limits väärtusi. Kõik võtmed jagavad neid limiite; uus token ei lähtesta neid. Paketimuutus võib jõustuda enne tokeni aegumist.

Näide: {"auth_per_minute":1,"read_per_minute":2,"write_per_minute":15}

token_typeStringValikuline

Bearer. Tagastatud tokeni autentimisskeem.

const: "Bearer"

Vaikeväärtus: "Bearer"Näide: "Bearer"

warningsMassiiv <TokenLifetimeWarning > Kohustuslik

Vahemikust väljas täisarv määrab 900 sekundit ja tagastab warnings koos token.ttl_out_of_range ning documentation_url lingiga learn.shopently.com lehele. Puuduv väli hoiatust ei tekita; vale tüüp tagastab 422.

Näide: []

Lisaväljad: Ei

applied_secondsTäisarvValikuline

900 s (15 min)

Vaikeväärtus: 900

codeStringValikuline

token.ttl_out_of_range

const: "token.ttl_out_of_range"

Vaikeväärtus: "token.ttl_out_of_range"

documentation_urlStringValikuline

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

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

fieldStringValikuline

ttl_seconds

const: "ttl_seconds"

Vaikeväärtus: "ttl_seconds"

max_secondsTäisarvValikuline

3600 s (60 min)

Vaikeväärtus: 3600

messageStringValikuline

Vahemikust väljas täisarv määrab 900 sekundit ja tagastab warnings koos token.ttl_out_of_range ning documentation_url lingiga learn.shopently.com lehele. Puuduv väli hoiatust ei tekita; vale tüüp tagastab 422.

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

min_secondsTäisarvValikuline

300 s (5 min)

Vaikeväärtus: 300

Lisaväljad: Ei

auth_per_minuteTäisarvKohustuslik

Väljastamis- ja tühistamispäringud minutis, sealhulgas ebaõnnestunud autentimine. Mõlemad jagavad auth-piiri.

minimum: 0maximum: 1000000

Näide: 1

read_per_minuteTäisarvKohustuslik

Lugemispäringuid minutis.

minimum: 0maximum: 1000000

Näide: 2

write_per_minuteTäisarvKohustuslik

Kirjutamispäringuid minutis; see väärtus ei anna kirjutamisõigusi.

minimum: 0maximum: 1000000

Näide: 15

Lisaväljad: Ei

ttl_secondsTäisarvValikuline

Valikuline täisarv ttl_seconds: 300–3600 sekundit (5–60 minutit). Välja puudumisel on vaikeväärtus 900 sekundit (15 minutit).

Vaikeväärtus: 900Näide: 1800

Lisaväljad: Ei

access_tokenStringKohustuslik

Saada POST /api/v1/auth/revoke väljastanud võtmega päises Authorization: ApiKey ja pääsutõendiga JSON-väljal access_token. Pärast edu tagastab järgmine kasutus 401. Korduv, tundmatu või võõras tõend saab sama revoked: true; teiste võtmete tõendeid ei kustutata.

minLength: 1maxLength: 256

Näide: "shpt_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"

Lisaväljad: Ei

revokedTõeväärtusValikuline

Saada POST /api/v1/auth/revoke väljastanud võtmega päises Authorization: ApiKey ja pääsutõendiga JSON-väljal access_token. Pärast edu tagastab järgmine kasutus 401. Korduv, tundmatu või võõras tõend saab sama revoked: true; teiste võtmete tõendeid ei kustutata.

const: true

Vaikeväärtus: trueNäide: true

Lisaväljad: Ei