2. Popis protokolu HTTP API

Všechny příkazy HTTP API jsou odesílány pomocí HTTP nebo HTTPS protokolu na adresu interkomu s absolutní cestou doplněným prefixem /api. Volba protokolu závisí na aktuálním nastavení interkomu v sekci Služby / HTTP API. Funkce HTTP API jsou rozděleny do služeb a u každé služby je možné nastavit požadovanou úroveň zabezpečení včetně požadavku na TLS spojení (tj. HTTPS protokol)

Příklad: Sepnutí spínače 1 http://10.0.23.193/api/switch/ctrl?switch=1&action=on

Absolutní cesta obsahuje název skupiny funkcí (systém, firmware, config, switch apod.) a název funkce samotné (caps, status, ctrl apod.). 
Minimalistická varianta požadavku akceptovaná interkomem musí obsahovat řádek požadavku s metodou a absolutní cestou následovaný hlavičkou Host:

Příklad:

GET /api/system/info HTTP/1.1 
Host: 10.0.23.193 
HTTP Server interkomu odpoví zprávou:
HTTP/1.1 200 OK
Server: HIP2.10.0.19.2
Content-Type: application/json
Content-Length: 253
{
  "success" : true,
  "result" : {
    "variant" : "2N IP Vario",
    "serialNumber" : "08-1860-0035",
    "hwVersion" : "535v1",
    "swVersion" : "2.10.0.19.2",
    "buildType" : "beta",
    "deviceName" : "2N IP Vario"
  }
}

V této kapitole dále naleznete: