Used primarily for direct sensor communication during development. Pass the username and password in the HTTP header ( Authorization: Basic ).
Xovis hardware utilizes a "Privacy-by-Design" architecture where stereo-vision lenses capture video, calculate 3D depth maps, and run AI inference models strictly inside the sensor housing. This design ensures that raw video never leaves the device. The data exposed through the Xovis Sensor API falls into three core functional categories: Full-featuring APIs - Xovis
Xovis sensors provide a robust designed for system integrators to build custom retail analytics, queue detection, and passenger flow solutions. Core Documentation Resources Official Support Portal : Comprehensive documentation, product manuals, and the Xovis Sensor Explorer tool are available via the Xovis Customer Portal Sensor V5 OpenAPI xovis api documentation
All API communication should be encrypted using TLS to prevent credential sniffing and data tampering. Example Authentication Header: Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ= Use code with caution. 3. Core API Endpoints and Data Payload Examples
For the most updated technical specs, always refer to the official Xovis API documentation . This design ensures that raw video never leaves the device
Data regarding people entering or exiting designated areas.
├── /info │ └── /info/status # Device health, firmware, calibration validation ├── /count_data │ └── /count_data/lines # Cross-line event tallies (In/Out metrics) └── /capacity_data └── /capacity_data/zones # Real-time occupancy mapping inside defined polygons Sensor Status Validation GET /info/status rather than the server arrival time
When building software that relies on the Xovis API, observing these developer best practices will ensure system stability and clean data processing:
When synchronizing multiple sensors across a large facility, use the UTC timestamp provided inside the data payload , rather than the server arrival time, to avoid time-skew errors.
To get the current fill level of a specific zone or the count data from a designated "line" (doorway), you send a GET request to the data endpoint. /api/v4/elements/counts Method: GET Sample JSON Response:
: Detailed object data from AI extensions like Gender Statistics or Staff Exclusion .