Skip to end of metadata
Go to start of metadata

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

Kompletní popis lze najít v online manuálu pro HTTP API: 

2N® IP Interkom HTTP API manuál

Zde je uveden příklad. Pokud stáhnte ze zařízení HIP konigurační soubor ve formátu .xml a pro lepší přehlednost otevřete např. v programu Notepad++ můžete upravit parametry dle Vašich potřeb, například:

V obrázku výše je výstřižek z nastavení RTSP parametrů, kde např. pro kodek H.264 jsou parametry Framerate - 2, Resolution - 2, and Bitrate - 4, toto odpovídá nastavení těchto parametrů pomocí webového rozhraní. Číslo parametru není zvoleno náhodně, ale odpovídá pořadí parametrů v rolovacím menu pro jednotlivé parametry webového rozhraní. Tudíž např. pro nastavení parametrů H.264:

 

Video resolution CIF - platí č. 2 v xml databázi

 

Video Frame rate 30 fps -   platí č. 2 v xml databázi

 

Video Bit Rate 512 kbps - platí č. 4 v xml databázi

V logice přidělování parametrů je první možnost vždy přiřazena k číslu "0"

 

Funkce /api/config slouží k uploadu nebo downloadu konfigurace zařízení.

Funkce je součástí služby System a v případě použití autentizace je nutné, aby uživatel měl přiřazené privilegium Systém Control. Funkce je dostupná pouze po zadání licenčního klíče zahrnujícího licenci Enhanced Integration. Pro tuto funkci lze použít metodu PUT pro upload konfigurace.

V případě uploadu konfigurace je odpověď ve formátu application/json a neobsahuje žádné další parametry.

Příklad:

PUT /api/config
{
  "success" : true
}
Příklad PUT requestu může vypadat např. takto:  https://192.168.50.163/api/config , kde168.50.163 je  IP adresa interkomu. Můžete si vyzkoušet pomocí HTTP API test tool dostupné zde: https://_IP _intercom_address/apitest.html

Příklad z tohoto Test tool je na obrázku níže, kde Váš upravený .xml soubor bude nahrán políčkem Configuration