REST API koppeling
Externe apparaten gebruiken de REST API koppeling om te communiceren met de Octalarm alarmmelder.
Goed om te weten: voor elk extern apparaat dat u wilt verbinden, voegt u een REST API koppeling in de melder toe. De Octalarm alarmmelder ondersteunt meerdere REST API koppelingen, elk met een eigen token.
Instellen REST API koppeling(en)
- Voeg een REST API koppeling toe.
Goed om te weten: het toevoegen van een REST API koppeling gaat via Instellen op afstand. Zie Het portaal: portal.octalarm.com en Instellen op afstand (lokaal) voor verdere toelichting.
- Vraag het token op. Dit token heeft u nodig om de REST API koppeling te testen met de OpenAPI (Swagger) tool.
- Klik op de info knop (
i
). - Klik op
Kopieer token naar klembord
. - Klik op
Sluiten
.
- Klik op de info knop (
- Verifieer de koppeling met de OpenAPI (Swagger) tool. Zie Octalarm Link|Algemene methoden en responsen: Authenticatie voor verdere toelichting.
- Type bij Value in het autorisatiescherm Bearer, gevolgd door een spatie en plak het gekopieerde token.
- Klik op
Autorize
.
Let op: herhaal deze stappen voor elk extern apparaat dat u wilt verbinden.
Instellen watchdog meganisme
Om de verbinding tussen het externe apparaat en de Octalarm alarmmelder te bewaken, stelt u een watchdog mechanisme in.
"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: wanneer u geen nieuw watchdog verzoek doet binnen de door u gespecificeerde tijd, genereert de Octalarm alarmmelder een systeemstoring.