Skip to content

Klíče API

Klíče API otevírají programový přístup k dAio Business. Umožňují vašim vlastním aplikacím, skriptům a systémům dotazovat se přímo na platformu — počasí, kvalita ovzduší, pyl, námořní podmínky, oborové zpravodajství — bez nutnosti procházet webové rozhraní. Je to vstupní bod pro industrializaci vašich integrací: napájení ERP, spouštění podnikových procesů, zobrazování předpovědí ve vašem vlastním dashboardu.

Každý klíč ověřuje volání jménem vaší organizace a dědí její oprávnění. Ve spojení s webhooky vám poskytuje ucelený kanál: dAio dotazujete na vyžádání prostřednictvím API a dAio vás upozorňuje v reálném čase prostřednictvím webhooků.

Klíče API

Tip: vytvořte samostatný klíč pro každé použití (službu, prostředí, partnera). Jeden klíč můžete odvolat, aniž byste narušili ostatní, a přesně sledovat, která integrace co spotřebovává.

K čemu klíč API slouží

PotřebaKlíč API umožňuje…
IntegracePropojit dAio s vaším IS (ERP, CMMS, BI) bez zásahu člověka.
AutomatizaceSpouštět naplánované úlohy (denní stahování předpovědí, hodnocení rizik).
DistribuceZobrazovat data dAio ve vašich vlastních aplikacích nebo portálech.
Řízené sdíleníPoskytnout partnerovi omezený a odvolatelný přístup bez vytváření uživatelského účtu.

Informace: přístup k API je vyhrazen pro placené plány. Organizace bez aktivního předplatného obdrží při každém volání odpověď 403 (« API access requires a paid plan »).

Vytvoření klíče

Vytvoření klíče je vyhrazeno vlastníkovi (owner) a administrátorům (admin) organizace. Ostatní role nemohou klíče vytvářet ani odvolávat.

  1. Přejděte do Nastavení > Klíče API.
  2. Klikněte na Nový klíč vpravo nahoře.
  3. Zadejte popisný název identifikující použití klíče (např. « Produkční backend », « Konektor Power BI », « Integrace partnera X »).
  4. Klikněte na Vytvořit.
  5. Úplný klíč se zobrazí v zeleném banneru: okamžitě jej zkopírujte pomocí tlačítka pro kopírování.

Pozor: úplný klíč se zobrazí pouze jednou, v okamžiku jeho vytvoření. Poté se již nikdy nezobrazí — platforma uchovává pouze šifrovaný otisk. Pokud jej ztratíte, budete muset vygenerovat nový. Bezodkladně jej uložte do správce tajemství (Vault, AWS Secrets Manager, šifrované proměnné prostředí).

Po vytvoření se klíč objeví v seznamu se svým názvem, svým prefixem (prvních několik znaků, pro identifikaci bez prozrazení), indikátorem stavu (zelená = aktivní, červená = odvolaný) a svým datem posledního použití.

Použití klíče

Každý požadavek na API dAio musí obsahovat váš klíč v HTTP hlavičce X-API-Key. Základem API je https://api-dev.daio.app a B2B koncové body jsou opatřeny prefixem /api/v1/.

bash
curl -H "X-API-Key: VAS_KLIC_API" \
  "https://api-dev.daio.app/api/v1/weather/current?lat=48.8566&lon=2.3522"

Pozor: očekávaná hlavička je skutečně X-API-Key, nikoli Authorization: Bearer. Neplatný, odvolaný nebo v jiné hlavičce předaný klíč vrací odpověď 401 (« Invalid API key »).

Úplný seznam koncových bodů (počasí, hodinové předpovědi, kvalita ovzduší, pyl, námořní data, dávkové zpracování) a formát odpovědí najdete v technické dokumentaci API.

Limity rychlosti

Pro zajištění stability služby podléhá každý klíč hodinovému limitu rychlosti. Počítadlo je specifické pro každý klíč a resetuje se každou hodinu.

PlánPožadavků za hodinu
Zdarma / bez předplatnéhoŽádný přístup k API
Solo · Team · Enterprise (dAio Business)20 000

Po dosažení limitu vrací API odpověď 429 (« Rate limit exceeded ») doprovázenou hlavičkou Retry-After, která udává, jak dlouho čekat před opětovným pokusem.

Informace: tento hodinový limit je oddělený od měsíční kvóty požadavků zahrnuté ve vašem tarifu. Podrobnosti o kvótách jednotlivých plánů najdete v sekci Předplatné.

Rotace klíče

Rotace znovu vygeneruje klíč při zachování jeho názvu a pozice v seznamu. Použijte ji k pravidelné obnově svých tajemství, aniž byste museli překonfigurovat celou svou integraci.

  1. V seznamu klikněte na ikonu rotace (kruhová šipka) vedle klíče.
  2. Potvrďte operaci.
  3. Nová hodnota se zobrazí pouze jednou — okamžitě ji zkopírujte.
  4. Aktualizujte své aplikace touto novou hodnotou.

Tip: naplánujte rotaci každých 90 dní a systematicky po odchodu zaměstnance, který měl přístup k tajemstvím, nebo při podezření na únik.

Odvolání klíče

Pro přerušení přístupu kompromitovaného nebo nepoužívaného klíče:

  1. V seznamu klikněte na ikonu smazání (koš) vedle klíče.
  2. Potvrďte odvolání.

Odvolání je okamžité a nevratné. Jakýkoli požadavek používající odvolaný klíč okamžitě obdrží odpověď 401. Klíč zůstane viditelný v seznamu, označený Odvolaný, pro účely historie.

Bezpečnost klíčů

Klíč API se rovná heslu: kdokoli jej drží, může se dotazovat na API s oprávněními vaší organizace.

Pozor: nikdy nekomitujte klíč do svého zdrojového kódu nebo Git repozitáře, ani soukromého. Klíč omylem odeslaný do repozitáře je považován za kompromitovaný — bez prodlení jej odvolejte a proveďte rotaci. Nikdy jej nepředávejte e-mailem, zprávami nebo v tiketu podpory v otevřené podobě.

  • Ukládejte klíče do správce tajemství nebo proměnných prostředí, nikdy natvrdo v kódu.
  • Neodhalujte je na straně klienta (webová aplikace, mobil, JavaScript v prohlížeči): volání API musí vycházet z vašeho serveru.
  • Oddělujte: jeden klíč na prostředí (produkce, testovací) a na použití.
  • Sledujte datum posledního použití: klíč, který je dlouho neaktivní, je klíč k odvolání.

Osvědčené postupy

  • Pojmenujte explicitně každý klíč podle jeho použití a prostředí, abyste na první pohled poznali, co napájí.
  • Uplatňujte nejnižší oprávnění: vytvářejte vyhrazené a odvolatelné klíče namísto jediného klíče sdíleného všemi vašimi integracemi.
  • Automatizujte rotaci každých 90 dní a začleňte ji do svých procedur odchodu zaměstnanců.
  • Zpracujte 429 na straně klienta: respektujte hlavičku Retry-After a vyhlazujte svá volání místo řetězení požadavků za sebou.
  • Odvolejte okamžitě jakýkoli klíč podezřelý z kompromitace — odvolání nabývá účinnosti bez prodlení.
  • Dokumentujte interně, který klíč k čemu slouží a kdo za něj odpovídá, pro klidné bezpečnostní audity.

Tip: spojte své klíče API s webhooky pro ucelenou integraci — dotazujte dAio na vyžádání a nechte dAio, ať vás upozorní na události v reálném čase.

Guide utilisateur dAio Business