API - Ovládací rozhraní

API online

Syntaxe pro volání služby

Volání API online odesláním HTTP požadavku má následující syntaxi:

https://vektiva.online/api/<REMOTE_ID>/<API_KEY>/<DEVICE_ID>/<command>

Každé fyzické zařízení (SMARWI) má své unikátní DEVICE ID. REMOTE ID a API KEY získáte po registraci na vektiva.online (v menu pod položkou "API") a jsou společná pro všechna zařízení pod Vaším účtem.

<command> je jeden z následujících příkazů

  • open Akce otevření okna. Je možné využít další volitelný parametr (procentuální velikost otevření), do URL adresy přidejte /<INTEGER[1..100]>

  • close Akce zavření okna

  • stop Akce zastavení pohybu

  • fix Akce fixace okna

  • prio Prioritní spuštení aktivity na určenou dobu (od verze firmware 203.2.0)

    Poznámka

    Aktivita je "program" (soubor podmínek a akcí), který určuje chování zařízení po dobu svého běhu.

    celá syntaxe je prio/<delay_seconds>/<duration_seconds>/<ActivityName>[/param1[/[param2[/param3]]]

    • delay_seconds je počet vteřin do spuštění aktivity
    • duration_seconds je doba vykonávání aktivity v sekundách
    • ActivityName název aktivity tak, jak je definována v zažízení
    • param1..param3 jsou případné parametry aktivity

    Tato aktivita se poté vykonává "prioritně" v daném intervalu, tj. případnou stejnou aktivitu běžící v témže čase dle plánu přepisuje svými parametry.

  • queue Spuštění akce s časovým odstupem (od verze firmware 203.2.0)

    Poznámka

    Akce je jedna činnost, které může dané zařízení vykonac - např. zavřít okno

    Celá syntaxe queue/<delay_seconds>/<ActionName>[/param1[/[param2[/param3]]]

    • delay_seconds je počet vteřin do vykonání akce.
    • ActionName je název akce, kterou zařízení podporuje, vyjma prio a queue. (open, close, stop, fix...)
    • param1..param3 jsou případné parametry aktivity

API přes lokální síť

Volání API v rámci Vaší vnitřní sítě odesláním http požadavku má následující syntaxi:

http://IP/cmd/<command>

Kde IP je IP adresa daného SMARWI.

Příklady

Příklad 1 - lokální síť, zavři SMARWI na IP adrese 1.2.3.4

https://1.2.3.4/cmd/close

Příklad 2 - online, zavři SMARWI s ID 1111111111

https://vektiva.online/api/dndptketzd/12abc34def/1111111111/close

Příklad 3 – online, otevři SMARWI s ID 1111111111 na 30%

https://vektiva.online/api/dndptketzd/12abc34def/1111111111/open/30

Příklad 4 - lokální síť, naplánování aktivity

http://1.2.3.4/cmd/prio/10/20/ventilate/50

Spustí aktivitu "vetrej" od "teď"+10 vteřin do "teď"+30 vteřin, parametr pro aktivitu je 50 -- patrně 50% otevření, ale využití parametru závisí na aktivitě

Příklad 5 - online, naplánování aktivity

https://vektiva.online/api/dndptketzd/12abc34def/1111111111/prio/10/20/ventilate/50

Spustí aktivitu "vetrej" od "teď"+10 vteřin do "teď"+30 vteřin, parametr pro aktivitu je 50 -- patrně 50% otevření, ale využití parametru závisí na aktivitě

Příklad 6 - online, naplánování akce

https://vektiva.online/api/dndptketzd/12abc34def/1111111111/queue/20/open/50

Za 20 vteřin spustí akci 'open' s parametrem 50 -- otevře okno na 50%

Správnou funkci API volání si můžete snadno vyzkoušet zadáním požadavku do URL Vašeho prohlížeče. Po odeslání se vykoná požadovaná akce.