4.1.1 Dotazy
Samotná komunikace je založena na modelu klient-server. Klient dotazem žádá o data nebo o provedení příkazu a server mu odpovídá. Dotaz je tvořen URL s volitelnými daty v následujícím formátu:
https://<IP>/api/v1/<subsystem>?<parameters>
- IP je IP adresa IDT.
- <subsystem> je označení části systému, kterou bude chtít klient ovládat
- <parameters> jsou upřesňující argumenty dotazu
Např:
https://192.168.254.228/api/v1/gpio?action=set&name=io2&type=direction&value=out
značí, že v subsystému GPIO chceme přepnout směr přepínatelného GPIO na výstup.
Pokud jsou data, které chce klient v dotazu předat, obsáhlejší, potom se uloží do těla HTTP požadavku v JSON formátu (Content-Type: application/json; charset=UTF-8).
Tyto výjimky jsou uvedeny v seznamu parametrů příkazů.
V případě dotazu, který data nepředává, se jedná o HTTP metodu GET. V případě předání dat se používá metoda PUT.