5.4.7 HTTP API

HTTP API je aplikační rozhraní pro ovládání vybraných funkcí interkomu pomocí HTTP protokolu. Toto rozhraní umožňuje jednoduše integrovat interkomy 2N IP 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 interkomu.
  • Switch API – umožňuje řízení a sledování stavu spínačů, např. otvírání dveřních zámků apod.
  • I/O API – umožňuje řízení a sledování logických vstupů a výstupů interkomu.
  • 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.

U každé služby lze nastavit vyžadovaný způsob autentizace požadavků odesílaných na interkom. Pokud autentizace není provedena, požadavek je odmítnut. Požadavky jsou autentizovány pomocí standardního autentizačního protokolu popsaného v RFC-2617. Je možné volit tyto tři metody autentizace:

  • Žádná – služba nevyžaduje žádnou autentizaci. Služba je v tomto případě v lokální síti zcela nechráněná.
  • Basic – služba vyžaduje autentizaci Basic podle RFC-2617. Služba v tomto případě vyžaduje heslo, to je však odesíláno v otevřeném formátu. Doporučujeme tuto volbu kombinovat s HTTPS protokolem, pokud je to možné.
  • Digest – služba vyžaduje autentizaci Digest podle RFC-2617. Tato varianta je výchozí a z výše uvedených metod nejbezpečnější.

Detailní popis funkce a nastavení HTTP API je k dispozici v manuálu HTTP API

Poznámka

  • Kompletní HTTP API je dostupné pouze s licencí Gold nebo Enhanced Integration. Pouze část rozhraní (Camera API) je dostupné bez této licence.

Tip

  • Pro funkci Video Preview na telefonu Gigaset Maxwell 10 je potřeba na záložce HTTP API u položky Camera API nastavit Typ připojení = Nezabezpečené (TCP) a Autentizace = Žádná.