Autentifikācija
- Authorization: ApiKey
- API atslēgu sūta tikai POST /api/v1/auth/token pieprasījuma Authorization galvenē. Neievietojiet to JSON, URL vai vaicājuma parametros.
- Authorization: Bearer
- Resursu pieprasījumos izmantojiet saņemto marķieri un atjaunojiet to atbilstoši expires_at; expires_in ir izteikts sekundēs.
Kāpēc vispirms saņemt piekļuves pilnvaru?
API atslēga tiek izmantota piekļuves pilnvaras saņemšanai. Pilnvara ir derīga 15 minūtes un izmantojama vairākiem pieprasījumiem. Resursiem sūtiet tikai pilnvaru galvenē Authorization: Bearer.
Parastie pieprasījumi nesatur API atslēgu. Noplūdusi pilnvara nodrošina piekļuvi ne ilgāk kā līdz tās derīguma beigām. Nozagta API atslēga joprojām var ļaut saņemt jaunas pilnvaras.
Cik ilgi pilnvara ir derīga?
- expires_in
- 900 sekundes jeb 15 minūtes no izdošanas. Pieprasījumi nepagarina derīgumu.
- expires_at
- Derīguma beigu laiks UTC. Pašreizējie piekļuves ierobežojumi var bloķēt pilnvaru agrāk.
Kad saņemt jaunu pilnvaru?
Izmantojiet vienu pilnvaru vairākiem pieprasījumiem un saņemiet jaunu pirms expires_at. Neprasiet jaunu pilnvaru pirms katras darbības. Jaunas pilnvaras saņemšanai izmantojiet API atslēgu.
Piekļuve liegta un atkārtoti mēģinājumi
- 401
- 401 ne vienmēr nozīmē, ka pilnvaras derīgums ir beidzies. Ja tas ir beidzies, saņemiet jaunu un atkārtojiet lasīšanu ne vairāk kā vienu reizi. Ja pilnvaras saņemšana atgriež 401, pārbaudiet atslēgu un apturiet automātiskos mēģinājumus.
- 403
- Pie 403 pārbaudiet tiesības, IP ierobežojumus un plānu. Jauna pilnvara neatjauno atsauktu piekļuvi.
IP ierobežojumi
- Piekļuves marķieris neapiet atslēgas pašreizējās atļaujas, veikala lietošanas tiesības, atsaukšanu vai IP ierobežojumus.
- Ja nepieciešams, ierobežojiet atslēgas izmantošanu līdz integrācijas avota adresēm.
- Administrators var rediģēt sarakstu; atļautas ne vairāk kā 32 adreses.
Atslēgu pārvaldība
- API atslēgu pārvaldība ir atsevišķa no integrācijas resursu atļaujām.
- Tikai owner var grupām piešķirt atslēgu skatīšanas, izveides, rediģēšanas vai dzēšanas administratīvās atļaujas; pilnvarots grupas dalībnieks var veikt tikai šai grupai piešķirtās darbības.
Pieprasījumu biežuma ierobežojumi
Engine ≥ 4.143.0. Katra tokena atbilde ietver data.rate_limits no veikala politikas izdošanas brīdī. Visas atslēgas koplieto šos limitus; jauns tokens tos neatiestata. Plāna maiņa var stāties spēkā pirms tokena derīguma beigām.
- read_per_minute
- Lasīšanas pieprasījumi minūtē.
- write_per_minute
- Rakstīšanas pieprasījumi minūtē; šī vērtība nepiešķir rakstīšanas tiesības.
- auth_per_minute
- Tokena pieprasījumi minūtē, ieskaitot neveiksmīgus autentifikācijas mēģinājumus.