Device REST API

Endpoint Description Method Frequency
{ServerIPOrDomainName}/api/action/GetSettingPiBySerial?serial={serial} Device will call this endpoint to synchronize the configuration data between server and device POST Hourly
{ServerIPOrDomainName}/api/action/HeartbeatLite?serial={serial} Device will call this API to send a ping to the server to indicate that it's still able to contact
Topic Description Frequency
healthchecklog Device will send health check payload to this topic for near real time health check monitoring Every 5 seconds
ffc-eventrawdata Device will send counting data payload to this topic whenever detected moving object Event triggered
Data payload that device will push to server websocket topic
Updated on August 23, 2024