Amadis

Gateway Backend - APIs - Notify

Owned by Alexandre Munsch (Unlicensed)
Last updated: Jun 28, 2023
1 min read
[ 1 Notify the gateway of an important event ] [ 2 ]

Notify the gateway of an important event

Verb

POST

Resource

/api/gateway/v1/notify

Content type

application/json

Body

{

“type”:<type>,

“terminal”: {

“smrdId”: <smrdId>,

“smrdTerminalId”:<smrdTerminalId>,

“smriSecurityId”:<smriSecurityId>,

“smriSecurityState”:<smriSecurityState>

},

“info”:<info>

}

With:

  • “type”: Either “SECURITY” or “PROVISIONING”.

  • “terminal.smriSecurityId”: The terminal UUID.

  • “terminal.smriSecurityState”: Either “SECURE” or “UNSECURE”.

  • “info”: Additionnal information.

    • For “type” = PROVISIONING, the expected value is “SUCCESS” or “FAILURE”.