Webhooki iz pravil

Pravilo lahko ob sprožitvi pokliče URL. Tako vaš sistem takoj izve za dogodek, na primer za visoko temperaturo ali odklop naprave.

Preden začnete

• HAM Systems vklopi webhooke za vsak račun posebej. Če aplikacija prikaže Spletni vmesniki (webhooks) niso omogočeni za vaš račun, se obrnite na podporo.
• Potrebujete naslov https://, ki sprejema zahteve POST z interneta.

Dodajanje webhooka v pravilo

1. Odprite Meni. V skupini Orodja tapnite Pravila v oblaku.
2. Odprite pravilo ali ustvarite novo pravilo. Glejte Ustvarjanje pravila.
3. V dejanjih tapnite Dodaj dejanje.
4. Na seznamu izberite Webhook.
5. V polje URL vnesite naslov svojega sistema.
6. Če želite klic tudi ob ponastavitvi pravila, tapnite Dodaj dejanje ponastavitve in znova izberite Webhook.
7. Tapnite Shrani.

Računalnik

Telefon

Računalnik

Telefon

Če naslov ni pravilen, aplikacija prikaže URL ni veljaven.

Zahteva

Platforma pošlje POST s telesom JSON (Content-Type: application/json):

{
  "event": "triggered",
  "rule": {
    "id": 4321,
    "name": "Fridge 1 temperature",
    "serialno": "e11:123",
    "this_data": [ { "...": "the rule conditions" } ]
  },
  "device_data": {
    "e11:123": {
      "R": { "T": 912, "GI": 1, "GIC": 0, "GI2": 1, "GI2C": 0 },
      "O": [],
      "S": { "...": "the device settings" }
    }
  },
  "messages": []
}

Polje	Vsebina
event	triggered, ko se pravilo sproži. resolved, ko se izvede dejanje Ob ponastavitvi.
rule.id, rule.name	Številka in ime pravila
rule.serialno	Naprava pravila
rule.this_data	Pogoji pravila
device_data	Trenutno stanje vsake naprave pravila, po serijski številki. Enaka oblika kot posodobitve WebSocket.
messages	Napake, na primer Failed to get state of e11:123 for rule #4321, ko stanje naprave ni na voljo

Vrednosti v R so neobdelane. V primeru T: 912 pomeni 9.12 °C. Glejte definicije v REST API.

Platforma iz device_data odstrani podatke WiFi naprave (ime omrežja, geslo in podjetniške podatke).

Zaščita webhooka

Zahteva nima podpisa (HMAC). Za preverjanje, da zahteva prihaja iz vašega pravila:

1. Ustvarite dolgo naključno skrivnost, na primer z openssl rand -hex 32.
2. Skrivnost vstavite v poizvedbeni niz naslova: https://example.com/ham-hook?token=YOUR_SECRET.
3. V svojem sistemu zavrnite vsako zahtevo, ki nima pravilnega token.

Προσοχή

Vse osebe, ki vidijo pravilo, vidijo tudi naslov s skrivnostjo. Če se osebe z dostopom spremenijo, zamenjajte skrivnost.

Pravila in omejitve

• Naslov se mora začeti z https://.
• Platforma ne kliče lokalnih in zasebnih naslovov: localhost, 127.0.0.0/8, 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, 169.254.0.0/16, 100.64.0.0/10, 0.0.0.0/8 in sorodnih naslovov IPv6 (::1, fe80:, fc00::/7).
• Do 5 klicev na 60 sekund za vsako dejanje webhook v pravilu.
• Do 30 klicev webhook na 60 sekund za vsak račun.
• Platforma preskoči klice nad omejitvami. Pošlje jih ne pozneje.
• Platforma ne preverja stanja HTTP vašega odgovora in zahteve ne pošlje znova.
• Dejanje ima lahko zakasnitev (PO). Pravilo ima skupaj do 12 dejanj.

Preizkus

Za prvi preizkus uporabite javno storitev, ki prikaže prejete zahteve. Ustvarite pravilo z enostavnim pogojem in poglejte telo zahteve.

Glejte tudi

• Dejanja pravil
• Podatki v živo (WebSocket)
• Varnost