1. Úvod

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

HTTP API je podle funkce rozděleno do následujících služeb:

  • System API – umožňuje změny konfigurace, získání stavu a upgrade zařízení.
  • Switch API – umožňuje řízení a sledování stavu spínačů, např. otevírání dveřních zámků apod.
  • I/O API – umožňuje řízení a sledování logických vstupů a výstupů zařízení.
  • Audio API – umožňuje řízení přehrávání zvuků a monitorování mikrofonu zařízení.
  • Camera API – umožňuje řízení a sledování obrazu z kamery.
  • Display API – umožňuje řízení displeje a zobrazování uživatelských informací na displeji.
  • E-mail API – umožňuje ze zařízení odesílat uživatelské e-maily.
  • Phone/Call API – umožňuje řízení a sledování příchozích a odchozích hovorů.
  • Logging API – umožňuje vyčítat zaznamenané události zařízení

Pro každou službu lze nastavit transportní protokol (HTTP nebo HTTPS) a způsob autentizace (žádnáBasic nebo Digest). V konfiguraci HTTP API lze vytvořit až pět uživatelských účtů (s vlastním jménem a heslem) s možností detailního řízení přístupu k jednotlivým službám a funkcím.

HTTP API se konfiguruje pomocí konfiguračního webového rozhraní zařízení v záložce Služby / HTTP API. Zde lze povolovat a konfigurovat jednotlivé služby a nastavovat parametry uživatelských účtů. Pro demonstraci a odzkoušení funkce HTTP API slouží speciální nástroj integrovaný v HTTP serveru zařízení dostupný na adrese http(s)://ip_adresa_zařízení/apitest.html

Upozornění

 

Varování

Za účelem dosažení plné funkčnosti a zaručených výkonů důrazně doporučujeme vždy již při instalaci ověřit aktuálnost používané verze produktu či zařízení. Zákazník tímto bere na vědomí, že produkt či zařízení může dosahovat zaručených výkonů a být plně funkční dle propozic výrobce pouze v případě, je-li používána nejnovější verze produktu či zařízení, která byla otestována na plnou interoperabilitu a která nebyla výrobcem označena jako nekompatibilní s určitými verzemi jiných produktů, a to pouze v souladu s pokyny, návodem či doporučením výrobce a pouze ve spojení s vyhovujícími produkty a zařízeními jiných výrobců. Nejnovější verze jsou dostupné na internetových stránkách https://www.2n.com/cs_CZ/, popř. jednotlivá zařízení podle svých technických možností umožňují aktualizaci v konfiguračním rozhraní. Používá-li zákazník jinou než nejnovější verzi produktu či zařízení, popř. používá-li verzi, kterou výrobce označil za nekompatibilní s určitými verzemi jiných produktů, nebo používá-li zákazník produkt či zařízení v rozporu s pokyny, návodem či doporučením výrobce nebo ve spojení s nevyhovujícími produkty či zařízeními jiných výrobců, je srozuměn s veškerými případnými omezeními funkčnosti takového produktu či zařízení a s důsledky s tím spojenými. Použitím jiné než nejnovější verze produktu či zařízení, popř. verze, kterou výrobce označil za nekompatibilní s určitými verzemi jiných produktů, nebo použitím produktu či zařízení v rozporu s pokyny, návodem či doporučením výrobce, popř. použitím s nevyhovujícími produkty či zařízeními jiných výrobců, zákazník souhlasí s tím, že společnost 2N TELEKOMUNIKACE a.s. není odpovědná za jakékoli omezení funkčnosti takového produktu ani za újmu související s takovým případným omezením funkčnosti.

1.1 Revize dokumentu