Before diving into the code, it is essential to understand the flow of data. Xovis sensors (like the PC2 or PC3 series) operate independently or through the – the central software that aggregates data from multiple sensors.
Keep sensors on a secured VLAN, restricting API access to authorized server IPs or API gateways. 3. Core API Endpoints and Data Retrieval
: Integration tools like the Xovis User Guide for Niagara 4 allow for adjustable polling frequencies (Fast, Normal, Slow) to balance data freshness with network overhead. Common API Endpoints & Methods xovis api documentation
serves as a centralized platform for remote device management, system planning, and technical training. Key API Features & Capabilities Full-featuring APIs - Xovis
The Xovis API is a that allows external applications to communicate with the XCS. It returns data in standard JSON format, making it universally compatible with cloud services, on-premise databases, and modern web frameworks. Before diving into the code, it is essential
Security is paramount. The Xovis API primarily uses . You cannot access endpoints without a valid key generated within the XCS settings.
Explain what fields like objectCount , dwellTime , and queueLength mean in the context of Xovis. Response Codes: Document standard HTTP responses: 200 OK : Request successful. 401 Unauthorized : Authentication failed. 404 Not Found : Endpoint or data range does not exist. Key API Features & Capabilities Full-featuring APIs -
This section provides a step-by-step guide for setting up your first data integration using the Data Push method. This is the most common path for sending count data to an external system.
get_logs : Fetch system logs for troubleshooting and audit trails. Full-featuring APIs - Xovis
For real-time applications, sensors can be configured to "push" data to a remote endpoint at defined intervals or when specific events occur (e.g., a line crossing). Supported protocols for data push include HTTP(S) , (S)FTP , UDP , and MQTTS . Key API Endpoints and Functionalities
While this guide provides a strategic overview, the definitive source remains the official Xovis documentation delivered with your software. Always download the latest version, test against a sandbox XCS instance, and remember: high-quality people counting starts with hardware, but intelligence begins at the API.