API klíče

API klíče poskytují automatizovaným systémům, obchodním botům, provozním skriptům, reportovacím pipeline a FIX obchodním relacím programatický přístup k účtům vaší organizace. Tento článek popisuje model oprávnění API klíčů, mapování klíčů na účty, způsob, jakým správa organizace ovlivňuje operace iniciované klíči, a správu samotných API klíčů.

API klíče nejsou členy s přihlašovacími údaji. Mají vlastní, jednodušší model oprávnění:

Člen

Klíč API

Ověření

Individuální přihlášení pomocí 2FA

Přihlašovací údaje API klíče

Přístup k rozhraní

Ano

Ne, pouze přes API

Model oprávnění

Profil workflow + role účtu

Oprávnění API klíče aplikovaná na vybrané účty

Variabilita oprávnění dle účtu

Ano, role mohou přidělovat různá oprávnění na různých účtech

Ne, oprávnění klíče se jednotně vztahují na všechny vybrané účty

Může iniciovat žádosti o výběr a převod

Ano, pokud je to povoleno

Ano, pokud je to povoleno

Může schvalovat žádosti

Ano, kromě vlastních

Nikdy

Správní workflow

Ano, podle přiřazeného profilu pracovního postupu

Nikdy

Oba modely jsou záměrně odděleny. Členové mají role, profily a oprávnění na úrovni jednotlivých účtů, protože lidé přirozeně zastávají různorodé odpovědnosti. Klíče využívají plochý model oprávnění a účtů, protože automatizace by měla být úzce vymezená, jednotná a snadno auditovatelná na první pohled.

API klíč kombinuje dvě volby: co může dělat (oprávnění) a kde (účty).

Oprávnění

Skupina

Oprávnění

Co umožňuje

Prostředky

Dotaz na prostředky

Zobrazení zůstatků a stavu financování

Vložit

Generování adres pro vklad a zobrazení historie vkladů

Vybrat

Zahájení žádostí o výběr (viz „Správa a API klíče")

Earn

Alokace a zrušení alokace produktů Earn

Objednávky

Dotaz na otevřené příkazy

Zobrazení otevřených příkazů a aktivních obchodů

Dotaz na uzavřené příkazy

Zobrazení historických příkazů a dokončených obchodů

Vytvořit a upravit objednávky

Zadávání a úprava příkazů

Zrušení a uzavření příkazů

Zrušení otevřených příkazů a uzavření pozic

Adresy

Přidat adresu pro výběr

Zahájení žádostí o přidání adres na whitelist

Aktualizujte adresu pro výběr

Zahájení žádostí o změnu adres na whitelistu

Data

Dotaz na účetní knihu

Zobrazení transakcí a historie účetní knihy

Exportovat data

Export dat účtu pro reporting a rekonciliaci

Mapování účtů

Každý klíč je přiřazen k jednomu nebo více účtům – výběr se provádí při vytvoření klíče a lze jej později upravit. Oprávnění klíče se jednotně vztahují na všechny vybrané účty:

  • Klíč s oprávněními Dotaz na prostředky a Vytváření a úprava příkazů přiřazený ke dvěma účtům může na obou číst zůstatky a obchodovat – nic jiného mu přístupné není.
  • V rámci jednoho klíče nelze oprávnění nastavit pro každý účet zvlášť. Pokud vaše automatizace potřebuje na jednom účtu obchodovat a na druhém pouze číst data, použijte dva klíče. Každý klíč tak má jednoznačně vymezený rozsah působnosti.

Připojení přes FIX

Klíče s oprávněními pro příkazy podporují připojení přes FIX pro spotové obchodování, a to vedle rozhraní REST API a WebSocket API. Relace FIX přebírá stejná oprávnění a mapování účtů jako příslušný klíč: obchoduje pouze na vybraných účtech tohoto klíče a v rámci jeho oprávnění. Firmy provozující tok příkazů přes FIX zpravidla vyhrazují jeden klíč na relaci, přiřazený k účtům daného obchodního stolu.

Poznámka:

Obchodování přes WebSocket na jiných než hlavních účtech zatím API klíče nepodporují – jde prozatím o funkci vyhrazenou pouze pro vlastníky (Owner). Automatizovaný tok příkazů na dalších účtech by měl využívat REST nebo FIX. Viz Dostupnost a omezení.

Nastavení zabezpečení

Nastavení

Popis

Vypršení platnosti klíče

Volitelné datum, po jehož uplynutí klíč přestane fungovat

Počáteční / koncové datum dotazu

Omezení dotazů na zadané časové období

Připojení WebSocket

Zapnutí nebo vypnutí streamování dat v reálném čase

Vlastní okno jednorázového klíče

Nastavení ochrany proti opakovaným požadavkům pro vysokofrekvenční použití

Omezení IP adres

Omezení používání klíče na konkrétní IP adresy nebo rozsahy CIDR

Tip:

Každému klíči přidělte co nejužší oprávnění, nejméně účtů a nejpřísnější omezení IP adres, která mu umožní plnit jeho účel. Používejte samostatné klíče pro každý systém – jeden pro obchodního bota, jeden pro reporting – a zachovejte si možnost přesně cíleného zrušení přístupu.

Správa organizace se vztahuje jak na operace klíčů, tak na jejich správu.

Co klíče dělají

Pravidlo dvou kategorií platí pro klíče stejně jako pro členy:

  • Přímé operace se provedou okamžitě. Obchodování, Earn, dotazy na zůstatky, dotazy do účetní knihy a exporty dat se dokončí okamžitě, v rámci oprávnění a účtů daného klíče.
  • Řízené operace vytvářejí žádosti. Žádost o výběr nebo změnu adresy iniciovaná klíčem vstupuje do stejného procesu jako žádost iniciovaná členem: pravidlo pracovního postupu určuje, zda se dokončí okamžitě, nebo čeká ve frontě na lidské schválení.

Klíč může řízené žádosti pouze iniciovat. Klíče nikdy nemohou schvalovat – oddělení odpovědností vyžaduje, aby každé schválení provedl člen, a skript ho nemůže nahradit. Pokud zásada žádostí o výběr vyžaduje dvě schválení, čeká výběr iniciovaný klíčem na dva členy – stejně jako výběr iniciovaný členem.

Navrhujte automatizaci s ohledem na tuto asynchronnost: úspěšné volání API znamená, že žádost byla vytvořena, nikoli že se prostředky přesunuly. Sledujte žádost až do jejího dokončení a počítejte s tím, že čekající žádost neprovede rezervaci prostředků – pokud se zůstatek během posuzování změní, schválená žádost selže a je třeba ji znovu odeslat. Viz Udržujte prostředky dostupné až do schválení.

Klíče nemají přístup do správních pracovních postupů. Správa přístupu týmu, API klíčů, účtů, adres (nad rámec iniciování žádostí o adresu) a zásad je vyhrazena výhradně členům.

Správa klíčů

Vytváření, úpravy a odvolávání API klíčů jsou řízené operace v rámci vyhrazeného pracovního postupu Manage API Keys, odděleného od Manage Team & Access. Toto oddělení má dva důsledky:

  • Různí správci. Můžete provoznímu inženýrovi umožnit správu klíčů, aniž by měl možnost měnit přístupy členů, a naopak.
  • Různé zásady. Správa klíčů může mít vlastní požadavky na schvalování. Mnoho organizací vyžaduje nezávislé schválení pro vytvoření nebo úpravu klíče – nové přihlašovací údaje představují nový způsob přístupu k účtům – zatímco odvolání zůstává rychlé.
  1. Přejděte do sekce API klíče a vyberte Vytvořit klíč.
  2. Pojmenujte klíč podle jeho účelu – systému, který obsluhuje, a toho, co dělá – aby byla jeho funkce zřejmá při kontrolách i bezpečnostních incidentech.
  3. Vyberte oprávnění klíče.
  4. Vyberte účty, na kterých bude klíč pracovat. Oprávnění se vztahují na všechny vybrané účty stejně.
  5. Nakonfigurujte nastavení zabezpečení: vypršení platnosti, omezení IP adres, okno nonce.
  6. Zkontrolujte nastavení a potvrďte. Pokud zásada Správa API klíčů vyžaduje schválení, žádost čeká na potřebná schválení, než je klíč vydán.
Upozornění:

Úprava oprávnění nebo účtů klíče a jeho zrušení probíhají stejným řízeným postupem.

Řešení problémů

Volání vytvořilo žádost o výběr, kterou zásada Žádosti o výběr pozastavila ke schválení. Zkontrolujte stránku Žádosti – žádost je tam vedena s klíčem jako iniciátorem a čeká na schválení příslušnými členy. Přesně tak má model správy fungovat: automatizace navrhuje, lidé schvalují.

Pokud byla žádost schválena, ale prostředky se nepřesunuly, ověřte, zda zdrojový zůstatek v okamžiku dokončení pokrýval požadovanou částku – nevyřízená žádost prostředky nerezervuje, takže aktivita v průběhu kontroly může způsobit, že schválená žádost selže. Po obnovení zůstatku žádost znovu odešlete.

Daný účet není zahrnut v mapování účtů klíče. Klíč pracuje pouze s vybranými účty. Upravte klíč a přidejte daný účet – mějte na paměti, že se tam uplatní celá sada oprávnění klíče, protože klíče nepodporují odlišná oprávnění pro jednotlivé účty. Pokud je tato sada oprávnění příliš široká, vytvořte druhý klíč omezený na nový účet.

Jeden klíč nemůže mít různá oprávnění pro různé účty. Vytvořte dva klíče: obchodní klíč přiřazený k účtu A a klíč jen pro čtení přiřazený k účtu B. Klíče s užšími oprávněními se snáze auditují a jejich odvolání je bezpečnější.

Workflow správy API klíčů pravděpodobně vyžaduje schválení a žádost stále čeká na vyřízení. Klíč je vydán a jeho tajný kód zobrazen až po získání požadovaných schválení. Stav žádosti zkontrolujte na stránce Žádosti.

Ne. Schválení vždy vyžaduje člověka s rolí člena. Jde o systémové pravidlo, nikoli o konfigurovatelnou zásadu – díky němu má vícestranné schválení smysl ve chvíli, kdy automatizace spouští převody prostředků.

Potřebujete další pomoc?