Swarm Control Center API

Informationen zur API zum Abrufen spezifischer Daten aus dem Swarm Control Center.

Über eine API können Sie alle Einstellungen und Informationen, die im Swarm Control Center verfügbar sind, problemlos abrufen. Nachfolgend finden Sie die Swagger-Dokumentation, als Beispiel fungiert unsere Demo-Instanz: Swagger UI

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 unseren Support kontaktieren oder sie aus dem Quellcode Ihres Swarm Control Centers abrufen:

In unserem Beispiel lautet die URL:

https://demo-control-center-api-2a97516c.azurewebsites.net/v3/documentation/swagger-ui/#/

Beispiel

Rufen Sie zunächst den Gerätestatus ab:

1. Rufen Sie die Swagger UI auf

2. 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"
}

3. Die verschiedenen Status sind wie folgt in der API-Dokumentation definiert:

Device Status Documentation

4. 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
  }
]