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
Metody příkazů
...
Hodnoty parametrů
Header content of API messages
The session parameter is used to identify of currently logged user. Is transmitted in the Cookie header and received in the Set-Cookie header. The session value is not static and may change during the active session. A missing or incorrect session value will result in the request being rejected (response error „401 Unathorized“). This does not apply to requests that do not require authorization (login, discovery).
Possible <error_status> values
"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
...
Overview of HTTP API Functions
/api/discovery – Get device type
/api/get – Reading of parameter value
/api/set – Writing of parameter value
/api/prop – Reading of parameter property
/api/login – Login user
/api/logout Logout user
Change password
Downloading file
Uploading file