Control center API

Information on the API for retrieving specific data from the Control Center

You can easily retrieve all settings and information available in the Control Center via an API. Below you will find the Swagger documentation. Here is an example: BMA Control Center

In general, we stick to the OAuth 2.0 Client Credentials Flow (Microsoft) documented here.

Make sure to include your Tenant ID as a header in the authentication flow.

How to get the URL for your specific API

To get the first part of the URL for your specific API documentation or Swagger UI, you can either contact our Support or retrieve it from the source code of your Control Center.

In our example, the URL is:

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

Example

Retrieve device status

1. call the Swagger UI

2. the API call gives you information about the device status as follows

{
  "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. the different statuses of the devices are defined as follows in the API documentation

Box Status

4. you can also retrieve the status of the individual streams. The API provides the following results

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