Aufbau eines API-Requests

• Struktur
• Werte

Struktur

Die API wird mittels einfachem HTTP-Request angesteuert. Im Body dieses Requests werden Daten als JSON-Objekt mitgesendet.

Ein Beispiel-Request an die API zum Auslösen eines Rufes sieht wie folgt aus:

POST /api/v1/visicall
Content-Type: application/json  

{
  "target": "48:88:1F:C9:B0:BA",
  "consumer": "8d8d52b6-ab21-4984-8abc-c5640b2e107e",
  "hash": "2c74049f7b3ce927cefaaa4162c98abe234f971f",
  "data": {
      "event": "Flucht",
      "position": "Haupteingang"
  }
}

Werte

target

Identifikation des betroffenen Objekts. Je nach verwendeter GETS-Zentrale erfolgt die Identifikation über eine GETS-ID (alte Zentrale) oder über die MAC-Adresse (neue Zentrale). Beispielsweise 48:88:1F:C9:B0:BA oder 002.

consumer

Die Identifikation des Konsumenten. Siehe Integration → Konfigurationswerte → Konsumenten-ID.

hash

Signatur des Webhooks. Siehe Webhooks → Signatur.

data

Objekt mit relevanten Daten zur Änderung. Beispielsweise:

{
    "data": {
      "event": "Flucht",
      "position": "Haupteingang"
    }
}