Získat API klíč
Obchodní API

Oprávnění a životnost klíče

Oprávnění, platnost a povolené IP adresy zvolíte při vytvoření klíče a pak je nelze změnit.

Oprávnění

Klíč nese jedno nebo víc oprávnění. Vybíráte je v aplikaci Coinero v sekci Profil a zabezpečení, v dialogu Vytvořit API klíč, pod názvy Tržní data, Účet a Obchodování.

OprávněníV aplikaciCo dovolujePodpis
marketTržní dataČtení cen, trhů, knihy pokynů, obchodů, svíček a stavu API. Mají ho všechny klíče.Ne
accountÚčetČtení zůstatků, pokynů, obchodů, vkladů a výběrů účtu.Ano
tradeObchodováníOvěření, zadávání a rušení pokynů. Vyžaduje i oprávnění account, které aplikace zapne současně.Ano

Každý endpoint v přehledu API uvádí, které oprávnění vyžaduje. Klíč bez něj dostane HTTP 403 s kódem INSUFFICIENT_PERMISSION a polem requiredPermission. Opakování se stejným klíčem nepomůže: oprávnění nelze dodatečně změnit, vytvořte nový klíč.

Podmínky vydání

  • Klíč jen s market si vytvoří každý přihlášený klient s ověřeným e-mailem. Ověření totožnosti se nevyžaduje.
  • Klíč s account nebo trade vyžaduje zapnuté dvoufázové ověření (kód zadáváte při vytvoření) a ověření totožnosti posouzené stejnými pravidly, podle kterých aplikace pouští nákup. Klient, kterému aplikace obchod zakazuje, například kvůli rozšířenému ověření nebo omezení účtu, klíč s těmito oprávněními nezíská.
  • Klíč s trade navíc vyžaduje souhlas s podmínkami užití API ve verzi, která obchodování pokrývá (od verze 1.1). Dokud takové podmínky nejsou vydané, aplikace volbu Obchodování nenabídne.
  • Souhlas s podmínkami užití API je podmínkou každého klíče; aplikace si pamatuje verzi, se kterou jste souhlasili.
  • Klient může mít nejvýš pět živých klíčů (nezrušených a nevypršelých) a jejich názvy se nesmí shodovat.

Klíč a secret se zobrazí jen jednou, hned po vytvoření. Secret potřebujete k podpisu požadavků u oprávnění account a trade.

Expirace

Platnost je volitelná: 30, 90, 180 nebo 365 dní, nebo bez expirace. Expirace není povinná ani u oprávnění trade. Klíč přestane platit na konci zvoleného dne v pražském čase (23:59:59). Platnost nejde prodloužit; před koncem vytvořte nový klíč a přepněte na něj své systémy.

  • Zhruba sedm dní před koncem platnosti dostane držitel klíče e-mail s upozorněním.
  • Po vypršení (v noci po posledním dni platnosti) dostane e-mail, že klíč přestal platit.
  • Vypršelý klíč se nepočítá do limitu pěti živých klíčů.

Omezení na IP adresy

Při vytvoření můžete zadat až 10 IP adres nebo rozsahů v zápisu CIDR, ze kterých smí klíč přijít. Zadat lze IPv4 i IPv6; holá adresa se bere jako rozsah o jedné adrese. Rozsah musí mít za délkou prefixu samé nuly: 203.0.113.0/24 je platný zápis, 203.0.113.5/24 ne. Prázdný seznam klíč neomezuje.

U klíče s oprávněním trade omezení doporučujeme: uniklý klíč se secretem pak nelze použít z cizí adresy. Požadavek z adresy mimo seznam dostane HTTP 403 s kódem IP_NOT_ALLOWED, a to i při handshaku WebSocketu. Seznam se kontroluje po ověření klíče a před podpisem. Seznam nejde dodatečně změnit; pro jinou adresu vytvořte nový klíč. API posuzuje adresu, ze které požadavek dorazil, tedy u serveru za překladem adres (NAT) nebo proxy jeho odchozí veřejnou adresu.

Co se stane, když klíč přestane platit

Klíč přestane platit v pěti případech. Ve všech odpovídá API HTTP 401 s kódem INVALID_API_KEY; konkrétní příčinu z bezpečnostních důvodů nerozlišuje, vidíte ho v aplikaci u klíče.

SituaceCo se stane
VypršeníKlíč přestane platit v okamžiku expirace a nejde obnovit.
ZrušeníZrušíte ho v aplikaci, nebo ho zruší Coinero (například při porušení podmínek). Zrušení je nevratné. Klíč s oprávněním trade se zruší i při odvolání ověření totožnosti.
PozastaveníPři soustavném překračování limitu, které pokračuje i po upozornění e-mailem, může Coinero klíč pozastavit. Pozastavení je vratné a klíč se během něj chová jako zrušený (401 INVALID_API_KEY).
Zablokování, deaktivace nebo zrušení účtuVšechny klíče účtu se zruší automaticky.
Změna hesla nebo dvoufázového ověřeníPo změně nebo obnovení hesla a po resetu dvoufázového ověření (i když ho na vaši žádost vypne podpora Coinera) Coinero všechny klíče účtu automaticky zruší. Když si dvoufázové ověření vypnete sami, zruší klíče s oprávněním account nebo trade, klíče jen s market platí dál. O zrušených klíčích vám přijde e-mail. Vydejte si nové klíče a nahraďte je v nastavení svých aplikací.

Otevřená spojení WebSocketu, která klíč používají, se zavřou kódem 1008 s důvodem INVALID_API_KEY nejpozději do 60 sekund. Pokyny zadané klíčem zůstávají pokyny vašeho účtu: zrušením klíče se neruší, otevřené pokyny zrušíte v aplikaci Coinero.

API si kladný výsledek ověření klíče krátce pamatuje, takže zrušení nebo pozastavení se projeví nejpozději za minutu. Vypršení platí přesně v okamžiku expirace.