Xovis provides comprehensive API documentation primarily through its partner platform and dedicated support portals. Accessing Documentation
The documentation is largely restricted to registered partners and customers. You can access it through the following channels:
: The central platform for partners to access technical materials, manuals, and training. Xovis Support Portal
: A Jira-based portal where customers can find product information and documentation. Postman API Network : An unofficial but detailed OpenAPI specification for Xovis Sensor V5 API xovis api documentation
is available for public reference, covering basic authentication and endpoint structures. atlassian.net API Features
Xovis 3D Sensors offer several integration methods to build custom analytics solutions:
: Used to control sensor functions and pull pre-processed data. Data Push Options Example curl (fetch device list) curl -H "Authorization:
: Configurable via the sensor's web interface to send real-time telemetry data (like line crossings) in formats to external drivers or platforms. AI Extensions : APIs support managing plugins for advanced features like Staff Exclusion Gender Statistics Object Detection Developer Tools Xovis Sensor Explorer
: A utility for discovering sensors on a local network and configuring IP settings. Firmware Support
: Current documentation primarily focuses on sensors with firmware versions 5.0 and higher Full-featuring APIs - Xovis API Access >
curl -H "Authorization: Bearer YOUR_TOKEN" \
"https://<xovis-host>/api/devices"
Security is paramount. The Xovis API primarily uses API Key authentication. You cannot access endpoints without a valid key generated within the XCS settings.
From the docs:
Authorization: Apikey your-secret-key-hereVersion: 3.0 (Generic Reference)
Base URL: https://api.xovis.io/v3
Xovis provides comprehensive API documentation primarily through its partner platform and dedicated support portals. Accessing Documentation
The documentation is largely restricted to registered partners and customers. You can access it through the following channels:
: The central platform for partners to access technical materials, manuals, and training. Xovis Support Portal
: A Jira-based portal where customers can find product information and documentation. Postman API Network : An unofficial but detailed OpenAPI specification for Xovis Sensor V5 API
is available for public reference, covering basic authentication and endpoint structures. atlassian.net API Features
Xovis 3D Sensors offer several integration methods to build custom analytics solutions:
: Used to control sensor functions and pull pre-processed data. Data Push Options
: Configurable via the sensor's web interface to send real-time telemetry data (like line crossings) in formats to external drivers or platforms. AI Extensions : APIs support managing plugins for advanced features like Staff Exclusion Gender Statistics Object Detection Developer Tools Xovis Sensor Explorer
: A utility for discovering sensors on a local network and configuring IP settings. Firmware Support
: Current documentation primarily focuses on sensors with firmware versions 5.0 and higher Full-featuring APIs - Xovis
curl -H "Authorization: Bearer YOUR_TOKEN" \
"https://<xovis-host>/api/devices"
Security is paramount. The Xovis API primarily uses API Key authentication. You cannot access endpoints without a valid key generated within the XCS settings.
From the docs:
Authorization: Apikey your-secret-key-hereVersion: 3.0 (Generic Reference)
Base URL: https://api.xovis.io/v3