REST API-koppeling

Met een REST API-koppeling laat u externe apparaten communiceren met de Octalarm alarmmelder.

Goed om te weten: voor elk extern apparaat voegt u een aparte REST API-koppeling toe in de Octalarm alarmmelder. Elke koppeling heeft een eigen token. U kopieert dit token naar het externe apparaat waarmee u koppelt.

REST API-koppeling(en) toevoegen

Goed om te weten: u voegt een REST API-koppeling toe via Instellen op afstand. Zie Het portaal: portal.octalarm.com of Instellen op afstand (lokaal).

• Ga naar Instellingen.
• Scrol in de navigatie naar Octalarm Link.
• Klik op Wijzigen.
• Klik op Toevoegen.
• Geef de koppeling een duidelijke naam die het externe apparaat of de procescomputer beschrijft.
• Klik op Toevoegen om de koppeling op te slaan.
• Herhaal de 3 bullets hierboven als u meerdere externe apparaten wilt koppelen.
• Klik op Terug om het menu te verlaten.

Token(s) opvragen en gebruiken

Het token koppelt uw externe apparaat aan de REST API-functionaliteit van de alarmmelder. Dit token kunt u gebruiken:

• voor het testen van de koppeling in een OpenAPI (Swagger) tool;
• om de koppeling in te stellen op uw externe apparaat.

Het token vraagt u als volgt op:

• Klik op de info-knop (i) naast de koppeling.
• Klik op Kopieer token naar klembord.
• Klik op Sluiten.

Testen met een OpenAPI (Swagger) tool

• Typ bij Value in het autorisatiescherm Bearer gevolgd door een spatie en het gekopieerde token.
• Klik op Authorize om te testen.

Koppelen met uw externe apparaat

Kopieer het token naar uw externe apparaat volgens de instructies van de betreffende procescomputer.

REST API-instellingen wijzigen of verwijderen

• Ga naar Instellingen.
• Scrol in de navigatie naar Octalarm Link.
• Klik op Wijzigen.
  1. Gebruik het pen-icoon () om de naam te wijzigen of een nieuw token te genereren.
  2. Gebruik het prullenbak-icoon () om koppelingen die niet meer nodig zijn te verwijderen.
• Klik op Terug om het menu te verlaten.

Let op: als u een koppeling verwijdert, verwijdert u ook alle bijbehorende instellingen voor deze REST API.

Watchdogmechanisme instellen

Stel een watchdogmechanisme in om actief te bewaken of de verbinding tussen het externe apparaat en de Octalarm alarmmelder nog werkt.

POST: /Interface/Watchdog

{
  "next_kick_before_secs": 60
}

cURL-code:

curl -X 'POST' \
  'http://192.168.10.72/rest_api/1/Interface/Watchdog' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE2MTI1MzQ0ODgsIm5iZiI6MTYxMjUzNDQ4OCwianRpIjoiNjY0NzI2NzAtYTRkMi00N2ZmLWFiMjUtNzAyMGYwOTkwNWJhIiwiZXhwIjoxNjEyNTM3OTg4LCJpZGVudGl0eSI6IlJFU1QtQVBJXzAwMDUiLCJmcmVzaCI6ZmFsc2UsInR5cGUiOiJhY2Nlc3MiLCJ1c2VyX2NsYWltcyI6eyJ1c2VyX2lkIjo1LCJyb2xlX2lkIjo1LCJsYW5ndWFnZSI6Im5sLU5MIn19.6xlCrMjNsKd9Eyq5ieS-MScZe6P1idstMCKPs5dfOd8' \
  -H 'Content-Type: application/json' \
  -d '{
  "next_kick_before_secs": 60
}'

Respons:

{
  "next_kick_before_secs": 60
}

Let op: als u niet binnen de opgegeven tijd een nieuw watchdog-verzoek verstuurt, meldt de Octalarm alarmmelder een systeemstoring.