Device REST API

EndpointDescriptionMethodFrequency
{ServerIPOrDomainName}/api/action/GetSettingPiBySerial?serial={serial}Device will call this endpoint to synchronise the configuration data between server and devicePOSTHourly
{ServerIPOrDomainName}/api/action/HeartbeatLite?serial={serial}Device will call this API to send a ping to server to indicate that it's still able to contact serverPOSTEvery 15 mins
{ServerIPOrDomainName}/api/action/DailyHeartbeat?serial={serial}Device call this API to send its summarized health check information to the serverPOSTDaily
The RESTful API that device is calling on different point of time
TopicDescriptionFrequency
healthchecklogDevice will send health check payload to this topic for near real time health check monitoringEvery 5 seconds
ffc-eventrawdataDevice will send counting data payload to this topic whenever detected moving objectEvent triggered
Data payload that device will push to server websocket topic
Updated on March 4, 2022