Mine sisu juurde
ShopentlyLearn

Andmeskeemid: Autentimine

Andmeskeemid: Autentimine. API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.

Andmeskeemid

Hangi · Pääsutõend — Autentimine — Vastus

ApiResponse_TokenData_ · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
dataTokenData Kohustuslik

Vastuse näide · TokenData.

Näide: {"access_token":"EXAMPLE_ACCESS_TOKEN","expires_at":"2026-01-01T12:00:00Z","expires_in":900,"rate_limits":{"auth_per_minute":10,"read_per_minute":60,"write_per_minute":10},"token_type":"Bearer"}
metaContextPageMeta ContextMeta PageMeta RequestMeta Kohustuslik

Vastuse metaandmed.

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

Lisaväljad: Ei

Hangi · Pääsutõend — Autentimine — Vastus

TokenData · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
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:00:00Z"
expires_inTäisarvValikuline

900 sekundit ehk 15 minutit väljastamisest. Päringute tegemine ei pikenda kehtivust.

Vaikeväärtus: 900Näide: 900
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":10,"read_per_minute":60,"write_per_minute":10}
token_typeStringValikuline

Bearer. Tagastatud tokeni autentimisskeem.

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

Lisaväljad: Ei

Päringusageduse piirangud

TokenRateLimitsData · 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. Null tähendab, et toiming pole saadaval, mitte piiramatut kasutust.
auth_per_minuteTäisarvKohustuslik

Tokenipäringuid minutis, sealhulgas ebaõnnestunud autentimiskatsed.

minimum: 0maximum: 1000000
Näide: 10
read_per_minuteTäisarvKohustuslik

Lugemispäringuid minutis.

minimum: 0maximum: 1000000
Näide: 60
write_per_minuteTäisarvKohustuslik

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

minimum: 0maximum: 1000000
Näide: 10

Lisaväljad: Ei

Hangi · Pääsutõend — Autentimine — Päringu sisu

TokenRequest · API vastuvõetavate või tagastatavate andmete väljad, tüübid ja piirangud.
ObjektLisaväljad: Ei

Lisaväljad: Ei