Zobrazit zdroj

HTTP API je aplikační rozhraní pro ovládání vybraných funkcí brány pomocí HTTP protokolu. Toto rozhraní umožňuje jednoduše integrovat 2N^® EasyGate IP s produkty třetích stran, např. systémy domácí automatizace, zabezpečovací a monitorovací systémy budov apod.

používáno integrovaným webovým klientem
zákazník může použít vlastního klienta
pro přenos dat se obvykle používá formát json
obsahuje parametry pro ovlivňování chování (mohou být v url a těle)
autentizace přihlášení probíhá pomocí uživatelského jména a hesla
neaktivní klient je po stanoveném timeoutu automaticky odhlášen
klient musí poslat proměnnou relace (cookie) s názvem "SID", kterou získá od zařízení v první odpovědi

Úrovně oprávnění

0	~~žádné~~
1	~~guest~~	~~jen pro získání statusu zařízení~~
2	~~admin~~	~~plný přístup bez funkcionality my2n~~
3	~~my2n~~	~~plný přístup včetně funkcionality my2n~~

Uživatelé

~~Existují dva pevní veřejní uživatelé: Admin s oprávněním admin a Guest s oprávněním guest.~~
~~Uživatel My2N s oprávněním my2n je přihlášen automaticky a pouze z My2N cloudu.~~
~~Defaultní heslo uživatele Admin je 2n a po přihlášení musí být změněno.~~

~~Defaultní heslo uživatele Guest není nastaveno a přihlášení nebude povoleno, dokud nedojde k jeho nastavení.~~

Metody příkazů

GET	požadavky stahující obsah ze zařízení nebo provádějící obecné příkazy
POST	požadavky stahující obsah ze zařízení nebo provádějící obecné příkazy

Hodnoty parametrů

"undefined"	parameter not exists
"bad value"	parameter value is out of range
"bad type"	wrong type of parameter value
"access denied"	parameter is not accessible for write
"no memory"	not enough memory
"error"	general internal error
"busy"	device is in busy state (e.g. during the factory init process or upgrade process)

Cesty k serveru API

200	úspěch
400	chyba příkazu
401	nepovoleno (požadován login)
500	chyba serveru
512	vnitřní chyba aplikace