Autentizace
Každý požadavek na API vyžaduje API klíč v hlavičce X-COINERO-APIKEY.
Odeslání klíče
Klíč posílejte v hlavičce X-COINERO-APIKEY u všech požadavků na API. Kořenová cesta, /health, /alive a OpenAPI specifikace klíč nevyžadují. Pro kořenovou cestu a specifikaci platí limity podle IP adresy.
Klíč nevkládejte do URL: mohl by se uložit do logů, historie prohlížeče nebo hlavičky Referer.
API nepovoluje volání z cizích stránek v prohlížeči (CORS), takže požadavek z frontendu neprojde ani s platným klíčem. Je to záměr: klíč vložený do stránky si přečte kdokoli, kdo si zobrazí její zdrojový kód. Volejte API ze serveru a klientovi posílejte až výsledek.
Vytvoření a správa klíčů
Klíče vytvářejte a rušte v sekci Profil a zabezpečení v aplikaci Coinero. Fungují pouze u aktivního účtu; při úniku klíč ihned zrušte.
Při vytvoření získáte klíč a secret a oba se zobrazí jen jednou. Do hlavičky X-COINERO-APIKEY patří klíč, tedy hodnota začínající ck_. Secret současné veřejné API nepoužívá; uschovejte si jej pro budoucí endpointy, které budou vyžadovat podpis požadavku.
API klíč uchovávejte na serveru.
Chyby autentizace
Při chybě autentizace API vrací HTTP 401 s jedním z následujících kódů. Konkrétní důvod neplatnosti klíče z bezpečnostních důvodů nerozlišuje.
| Kód | Příčina |
|---|---|
MISSING_API_KEY | V požadavku chybí hlavička X-COINERO-APIKEY. |
INVALID_API_KEY | Klíč neexistuje, je zrušený či pozastavený nebo patří neaktivnímu účtu. |
Obě situace podléhají limitu podle IP adresy, každá vlastnímu: požadavky bez hlavičky mají volnější limit než požadavky s klíčem, který nelze použít.