O API

Toto API slouží pro uživatele Infigy, kteří chtějí vyčítat data ze zařízení. Data v API jsou okamžitá. Každý požadavek jde až do samotného zařízení, které odpoví aktuální hodnotou - tzn. v datech není žádné zpoždění.

Dokumentace

<aside> ⚠️

API je stále ve vývoji, tzn. vyhrazujeme si právo provádět změny.

</aside>

API klíč

API klíč (token) si vytvoříte sami v aplikaci app.infigy.cz. Token může platit pro jedno zařízení, nebo pro celou skupinu zařízení – vždy ale jen pro zařízení a skupiny, ke kterým máte přístup vy.

Jak vytvořit token

1. Přihlaste se do app.infigy.cz a otevřete Uživatelský účet – klikněte na svůj e-mail v záhlaví aplikace, nebo přejděte rovnou na app.infigy.cz/me.

2. V sekci API tokeny klikněte na Spravovat API tokeny.

   

   Uživatelský účet se sekcí API tokeny a tlačítkem Spravovat API tokeny

3. Klikněte na Nový token. Vyplňte název (např. podle integrace, ve které token použijete), případně poznámku, a vyberte zařízení nebo skupinu, pro kterou má token platit.

   

   Dialog Nový API token s vyplněným názvem, poznámkou a vybraným zařízením

4. Klikněte na Vytvořit. Token se objeví v seznamu – ikonou oka ho zobrazíte, ikonou kopírování ho zkopírujete do schránky.

   

   Seznam API tokenů se skrytým tokenem a ikonami pro zobrazení a zkopírování

<aside> 🔑

S tokenem zacházejte jako s heslem. Token můžete kdykoli upravit nebo smazat – smazání okamžitě ukončí přístup k API. Pokud přijdete o přístup k zařízení nebo skupině (nebo bude váš účet zrušen), přestane fungovat i token.

</aside>

Auth header

API klíč je třeba přiložit do header ve formátu x-auth-token=XXX

Endpointy

GET /api/me

Testovací endpoint, který vrátí informaci o skupině nebo zařízení, na které je token navázaný (pole type je group nebo device). Zařízení může být ve více skupinách.