Control Center API

Über die API können Sie alle Einstellungen und Informationen, die im Control Center verfügbar sind, problemlos abrufen. Nachfolgend finden Sie die Swagger-Dokumentation. Hier ein Beispiel: BMA Control Center

Im Allgemeinen halten wir uns an den hier dokumentierten OAuth 2.0 Client Credentials Flow (Microsoft).

Stellen Sie sicher, dass Sie Ihre Tenant-ID als Kopfzeile in den Authentifizierungsfluss einfügen.

Wie Sie die URL für Ihre spezifische API erhalten

Um den ersten Teil der URL für Ihre spezifische API-Dokumentation, bzw. Swagger UI zu erhalten, können Sie entweder unser Support-Team kontaktieren oder sie aus dem Quellcode Ihres Control Centers abrufen.

Hinweis

In unserem Beispiel lautet die URL:

https://bernard-control-center-api-dc814a25.azurewebsites.net/v3/documentation/swagger-ui/index.html#

Beispiel

Abruf Gerätestatus

Rufen Sie die Swagger UI auf
Der API-Call gibt Ihnen wie folgt Auskunft zum Gerätestatus

{
  "boxStatus": {
    "connectionState": "CONNECTED",
    "runtimeState": "DISABLED"
  },
  "id": "676cac42-f3d6-416d-ac83-3f54f1c0bb43",
  "name": "7th NE parking garage entrance",
  "statusId": "676cac42-f3d6-416d-ac83-3f54f1c0bb43",
  "tags": [
    {
      "name": "Roxxon Energy Corporation"
    }
  ],
  "type": "P100"
}

Die verschiedenen Status der Geräte sind wie folgt in der API-Dokumentation definiert

Sie können ebenfalls den Status der einzelnen Streams abrufen. Die API liefert folgende Ergebnisse

[
  {
    "id": "fd02a4c9-5e55-4100-a2fd-d76d16993bce",
    "name": "",
    "model": "traffic-detector-urban-standard-fast",
    "streamStatus": {
      "state": "NOT_OPERATIONAL",
      "errorReason": [
        "ENGINE"
      ]
    },
    "enabled": true
  }
]