5.4.6 HTTP API

HTTP API je aplikační rozhraní pro ovládání vybraných funkcí zařízení 2N 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.

Služby

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í.
  • Access Control API – umožňuje řízení přístupů a způsob ověřování autentizace uživatele.
  • 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ů zařízení.
  • 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.
  • Logging API – umožňuje vyčítat zaznamenané události zařízen
  • Automation API – umožňuje nastavit Secure/Unsecure komunikaci a požadavky autorizace.

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 zařízení. 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 2N HTTP API. 

Záložka Účet 1–5

Zařízení umožňuje spravovat až pět uživatelských účtů určených pro přístup ke službám HTTP API. Součástí uživatelského účtu je jméno a heslo uživatele a tabulka přístupových práv uživatele k jednotlivým službám HTTP API.

  • Účet povolen – umožňuje povolit tento uživatelský účet.

  • Jméno uživatele – zadejte jméno uživatele pro autentizaci k HTTP API.
  • Heslo – zadejte heslo pro autentizaci k HTTP API.

Pomocí tabulky přístupových práv lze řídit privilegia uživatelského účtu k jednotlivým službám.