Autentimine
- Authorization: ApiKey
- API-võti saadetakse ainult POST /api/v1/auth/token päringu Authorization-päises. Ära lisa seda JSON-i, URL-i ega päringuparameetritesse.
- Authorization: Bearer
- Kasuta ressursipäringutes saadud tokenit ja uuenda seda expires_at järgi; expires_in on sekundites.
Miks esmalt token hankida?
API-võtit kasutatakse tokeni hankimiseks. Token kehtib 15 minutit ja sobib mitme päringu jaoks. Ressurssidele saada ainult token päises Authorization: Bearer.
Tavalised päringud ei sisalda API-võtit. Lekkinud token võimaldab juurdepääsu kõige kauem selle kehtivusaja lõpuni. Varastatud API-võti võib siiski võimaldada uute tokenite hankimist.
Kui kaua token kehtib?
- expires_in
- 900 sekundit ehk 15 minutit väljastamisest. Päringute tegemine ei pikenda kehtivust.
- expires_at
- Aegumisaeg UTC-s. Kehtivad juurdepääsupiirangud võivad tokeni varem blokeerida.
Millal uus token hankida?
Kasuta sama tokenit mitme päringu jaoks ja hangi uus enne expires_at aega. Ära hangi tokenit enne iga toimingut. Uue tokeni hankimiseks kasuta API-võtit.
Juurdepääs keelatud ja korduskatsed
- 401
- 401 ei tähenda alati tokeni aegumist. Kui token on aegunud, hangi uus ja korda lugemist kõige rohkem üks kord. Kui tokeni hankimine tagastab 401, kontrolli võtit ja lõpeta automaatsed katsed.
- 403
- 403 korral kontrolli õigusi, IP-piiranguid ja paketti. Uus token ei taasta tühistatud juurdepääsu.
IP-piirangud
- Pääsutoken ei tühista võtme kehtivaid õigusi, poe kasutusõigusi, võtme tühistamist ega IP-piiranguid.
- Vajaduse korral piira võtme kasutamine integratsiooni lähteaadressidega.
- Administraator saab nimekirja muuta; lubatud on kuni 32 aadressi.
Võtmete haldamine
- API-võtmete haldamine on integratsiooni ressursiõigustest eraldi.
- Ainult owner saab anda gruppidele võtmete vaatamise, loomise, muutmise või kustutamise haldusõigused; volitatud grupiliige saab teha ainult grupile lubatud toiminguid.
Päringusageduse piirangud
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.
- read_per_minute
- Lugemispäringuid minutis.
- write_per_minute
- Kirjutamispäringuid minutis; see väärtus ei anna kirjutamisõigusi.
- auth_per_minute
- Tokenipäringuid minutis, sealhulgas ebaõnnestunud autentimiskatsed.