Ověřování
- Authorization: ApiKey
- Klíč API se posílá výhradně v hlavičce Authorization požadavku POST /api/v1/auth/token. Nevkládejte jej do JSON, adresy URL ani parametrů dotazu.
- Authorization: Bearer
- Pro požadavky na zdroje používejte vrácený token a obnovujte jej podle expires_at; expires_in se uvádí v sekundách.
Proč nejprve získat token?
Klíč API slouží k získání tokenu. Token platí 15 minut a lze jej použít pro více požadavků. K prostředkům posílejte pouze token v hlavičce Authorization: Bearer.
Běžné požadavky neobsahují klíč API. Uniklý token umožní přístup nejdéle do konce své platnosti. Ukradený klíč API však může umožnit získávání dalších tokenů.
Jak dlouho token platí?
- expires_in
- 900 sekund, tedy 15 minut od vydání. Odesílání požadavků platnost neprodlužuje.
- expires_at
- Okamžik vypršení v UTC. Aktuální omezení přístupu mohou token zablokovat dříve.
Kdy získat další token?
Používejte stejný token pro více požadavků a nový získejte před expires_at. Není nutné získávat token před každou operací. K získání nového tokenu použijte klíč API.
Odepřený přístup a opakování
- 401
- 401 neznamená vždy vypršení tokenu. Pokud vypršel, získejte nový a čtení zopakujte nejvýše jednou. Pokud získání tokenu vrátí 401, zkontrolujte klíč a zastavte automatické pokusy.
- 403
- Při 403 zkontrolujte oprávnění, omezení IP a tarif. Nový token neobnoví odebraný přístup.
Omezení IP
- Přístupový token neobchází aktuální oprávnění klíče, oprávnění obchodu, odvolání přístupu ani omezení IP adres.
- Podle potřeby omezte klíč na zdrojové adresy integrace.
- Správce může tento seznam upravovat; přijímá se nejvýše 32 adres.
Správa klíčů
- Správa klíčů API je oddělena od oprávnění integrace k jednotlivým zdrojům.
- Pouze owner může skupinám udělit oprávnění k zobrazení, vytváření, úpravě nebo mazání klíčů; oprávněný člen skupiny smí provádět jen akce povolené této skupině.
Limity požadavků
Engine ≥ 4.143.0. Každá odpověď s tokenem obsahuje data.rate_limits z pravidel obchodu platných při vydání. Všechny klíče sdílejí tyto limity; nový token je neobnovuje. Změna tarifu může platit před vypršením tokenu.
- read_per_minute
- Požadavky na čtení za minutu.
- write_per_minute
- Požadavky na zápis za minutu; tato hodnota neuděluje právo zápisu.
- auth_per_minute
- Požadavky na token za minutu, včetně neúspěšných pokusů o ověření.