HTTP API - Jak pracovat s HTTP API na 2N® Indoor Touch

Toto FAQ popisuje, jak používat na zařízení 2N® Indoor Touch HTTP API a jak jej nakonfigurovat. 2N® Indoor Touch HTTP API je aplikační rozhraní navržené pro správu vybraných 2N® Indoor Touch funkcí pomocí HTTP příkazů. Umožňuje integraci s produkty třetích stran jako domácí automatizační, bezpečnostní a monitorovací systémy, atd.

 Typy&Triky pro začátek

• V manuálu najdete všechny příkazy, které můžete konfigurovat pomocí HTTP API jednotky 2N® Indoor Touch.

  Manuál

  https://wiki.2n.cz/hseit/api/latest/cs/4-http-api
  

• Komunikace je provedena pomocí HTTPS protokolu, který běží na protokolu 443. Autentifikace vyžaduje nejdříve přihlašení pomocí jména a heslo. 
  
  
• Uživatelé potřebují HTTP API licenci. Bez licence nebude HTTP API fungovat. Objednávací číslo je 91378395.

Jak použít HTTP API na 2N® Indoor Touch

1. Existují dvě možnosti, jakým způsobem se dá k HTTP API přistoupit. Je možné použít vlasní aplikaci či jakýkoliv webový prohlížeč.
2. Pro demonstraci je použita aplikace Postman. V prvním případě se uživatel autentizuje pomocí příkazu login metodou PUT a dále pak používá příkazy pomocí metody GET.
   
   
   
   
3. Druhou možností je webový prohlížeč. Přihlašte se do 2N® Indoor Touch, použijte pro přihlášení Vaše uživatelské jméno a heslo. Toto je důležité pro Vaši autentizaci. Bez přihlášení nebude HTTP API fungovat. Pro více informací prosím přejděte na tento manuál. manuál
   
   
   
   

4. Po autentizaci je možné využít HTTP API. Struktura příkazů musí být zachovat, tedy https://<IP>/api/v1/<subsystem>?<parameters>

• • IP je IP adresa 2N® Indoor Touch
  • <subsystem> je označení části systému, kterou bude chtít klient ovládat
  • <parameters> jsou upřesňující argumenty dotazu

          Příklad:  https://192.168.50.183/api/v1/maintenance/resetdevice

          Výsledek:  {

                           "data":{}

                         }

Jak přepnout relé na 2N® Indoor Touch pomocí HTTP API

1. Poté, co se přihlásíte do zařízení, použijte speciální HTTP API příkaz pro přepnutí relé.
   
   
   
   - struktura příkazu je https://<IP>/api/v1/gpio?action=set&name=<string>&type=<string>&value=<bit>, kde je nutné definovat jméno, typ a hodnotu
   
   

Jak aktivovat zámek dveří aplikace 2N® Helios IP Mobile pomocí HTTP API

1. Poté co se přihlásíte do zařízení, přidejte Váš 2N® Helios IP interkom do 2N® Helios IP Mobile aplikace. Toto je možné udělat oba způsoby jak pomocí webového prohlížeče, tak přímo z aplikace 2N® Helios IP Mobile.

   
   

           

   
   

   
   

2. Použijte HTTP API příkaz k aktivaci zámku dveří v 2N® Helios IP Mobile aplikaci. Důležitá část příkazu je sériové číslo uloženého intercomu a ID zámku, který byste rádi použili.