English
English
English
  • SWARM Documentation
  • What's new?
    • Version 2024.2
    • Version 2024.1
    • Version 2023.3
      • Update 1
  • SWARM in a nutshell
    • SWARM Perception Platform Overview
  • Quick start guide
    • P101, P401 or OP101
      • P101 - Perception Box
      • P401 - Perception Box
      • OP101AC - Outdoor Perception Box
      • OP101DC - Outdoor Perception Box
    • Virtual Perception Box
      • System requirements
      • Install VPX Agent on NVIDIA Jetson (Jetpack 4.6)
      • Install VPX Agent on NVIDIA Jetson (Jetpack 5.1.2)
      • Install VPX Agent on X86/NVIDIA Server
  • Solution areas
    • Traffic Insights
      • Set-up Traffic Counting
      • Set-up Traffic Counting with speed estimates
      • Set-up Intersection Insights
    • Parking Insights
      • Set-up Barrierless Parking
      • Set-up Barrierless Parking with ANPR
        • Set-up guide and recommendations - ANPR
      • Set-up Single Space/Multi Space Parking
        • Standard examples
    • Advanced Traffic Insights
      • Set-up Adaptive Traffic Control
      • Set-up Journey Time & Traffic Flow
        • Set-up guide - Installation
        • Technical concept
      • Set-up Queue Length Detection
    • People Entry/Exit counting
  • SWARM Control Center
    • Devices
      • Camera & Device Monitoring
      • Camera Configuration
        • Scenario Configuration
          • Models
          • Calibration support
          • Camera settings
        • Rule Engine
          • Use Case Examples for Rule Engine
      • Device Health
    • Data Analytics
      • Creation and organization of dashboards
      • Dashboard overview & Widget creation
        • Traffic Scenario
        • Parking Scenario
        • Generic Scenario
    • Data Integration
      • Data Analytics API (REST API)
      • Raw event data with Custom MQTT server
      • SCC API
    • Administration
      • Monitoring Alerts
      • License Management
      • User Management
  • Test & Performance measurements
    • Benchmarks
      • How do we measure Performance?
    • White paper for use cases
      • Traffic Counting
      • Barrierless Parking and ANRP
  • Useful knowledge
    • 🚒Troubleshooting Guidelines
    • Network Requirements
    • Browser Compatibility SCC
    • Our Object Classes
    • Number Plate Area Code
  • Guidelines
    • How to access the debug output?
    • How to use Azure IotHub as Custom Broker
    • VPX
      • Upgrade IotEdge from 1.1 to 1.4
      • Upgrade Jetpack from 4.4.1 to 4.6.0
  • Getting Support
    • Get in touch
    • FAQs
Powered by GitBook
On this page
  • How to gather the URL for your specific API
  • Example

Was this helpful?

Export as PDF
  1. SWARM Control Center
  2. Data Integration

SCC API

API to gather the specific data out of the Swarm Control Center

PreviousRaw event data with Custom MQTT serverNextAdministration

Last updated 1 year ago

Was this helpful?

Every setting and information available in the Control Center can be gathered via an API. The Swagger documentation for our demo instance as an example can be found here:

Generally we stick to the following OAUTH flow documented here

Make sure to add your tenant ID as a header in the authentication flow.

How to gather the URL for your specific API

To gather the first part of the URL for your specific API Documentation/Swagger UI you can either contact our support or grab it from the source code of your Control Center.

Example

Retrieve the device monitoring status

  1. Go to the Swagger UI

2. The API call above will give you the status of a device and returns the following:

{
  "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 states are defined in the API documentation below

4. You can as well get the state of the individual streams. The API returns the following:

[
  {
    "id": "fd02a4c9-5e55-4100-a2fd-d76d16993bce",
    "name": "",
    "model": "traffic-detector-urban-standard-fast",
    "streamStatus": {
      "state": "NOT_OPERATIONAL",
      "errorReason": [
        "ENGINE"
      ]
    },
    "enabled": true
  }
]
Swagger UI
OAuth 2.0 client credentials flow on the Microsoft identity platform - Microsoft Entra
Control Center API Documentation Link
Device Status Documentation