Xovis Api Documentation !exclusive!
Use the sensor's internal memory for historical data to avoid data loss during network outages. 5. Official Resources
Xovis takes security seriously. Integration typically requires: Generated within the Xovis Web UI.
Xovis API documentation covers advanced AI plugins that add layers of intelligence, such as:
The Xovis API is flexible regarding data serialization. For RESTful responses and data pushes, the sensor can output data in either JSON or XML (v2 or v1 legacy). For newer integrations, JSON is generally preferred due to its lightweight nature and wide support in analytics platforms. For legacy systems, XML v1 is still available for line count data. xovis api documentation
Scanning network for Xovis sensors and checking their operational status. Firmware Updates: Managing sensor updates.
Typically configured during the initial sensor provisioning stage.
| Object | Fields | Use Case | |--------|--------|----------| | | timestamp , direction (enter/exit), count , sensorId | Door counting | | Occupancy | zoneId , peopleCurrent , maxCapacity , timestamp | Restroom or queue management | | Trajectory | path (array of x,y points), duration , startZone , endZone | Heatmaps and path analysis | Use the sensor's internal memory for historical data
I can provide a tailored to jumpstart your development. Share public link
Count data tracks the number of people crossing a predefined virtual line (Count Line) or entering a specific zone.
For real-time applications, Xovis sensors can be configured to automatically "push" data to an external HTTP/HTTPS server or an MQTT broker at specified intervals (e.g., every 15 seconds, 1 minute, or 15 minutes). 2. Authentication and Security For newer integrations, JSON is generally preferred due
Trajectory data is only available via the real-time socket API, not the REST API, which is a notable limitation mentioned but not justified in the docs.
import requests from requests.auth import HTTPBasicAuth import json # Configuration variables SENSOR_IP = "192.168.1.50" USERNAME = "admin" PASSWORD = "your_secure_password" ENDPOINT = f"https://SENSOR_IP/api/v4/elements/counts" def fetch_xovis_data(): try: # Making a secure GET request to the Xovis sensor response = requests.get( ENDPOINT, auth=HTTPBasicAuth(USERNAME, PASSWORD), verify=True, # Ensure SSL certificates are validated in production timeout=10 ) # Check if response is successful if response.status_code == 200: data = response.json() print("Data successfully retrieved from Xovis Sensor:") print(json.dumps(data, indent=2)) return data elif response.status_code == 401: print("Authentication failed: Invalid username or password.") else: print(f"Failed to fetch data. HTTP Status Code: response.status_code") except requests.exceptions.Timeout: print("Error: The request timed out. Check network connectivity to the sensor.") except requests.exceptions.RequestException as e: print(f"An error occurred during integration: e") if __name__ == "__main__": fetch_xovis_data() Use code with caution. 5. Best Practices for Developers