Push API

Explanation on the management and usage of the Push API

Endpoints

If your requirement is to receive realtime data as soon as it arrives on the Sensolus platform, you can make use of the push API. The push API requires you to set up your own server that will function as an end point for REST calls generated on the platform.

The push API is based on making calls from the Sensolus platform to the integrating party. This requires you to set up a server to receive the incoming calls as REST or MQTT. In the platform, these calls are known as webhooks. The following figure shows the difference between the pull and push API:

We support 2 protocols for pushing data to external servers:

  • HTTP endpoint: the platform performs a standard REST call. You can configure the URL with optional placeholders and extra header fields. For servers that require a specific format, the json body can be customized with a script.
  • MQTT endpoint: MQTT is a lightweight protocol that is optimized for networks with small bandwidth and high latency. It supports simple publish/subscribe semantics and is specifically designed with IoT devices in mind. It is an ideal solution for integration of the Sensolus platform with existing IoT architectures where the platform can act as a hub that reliably captures the data, adds the device metadata and publishes them to specific topics based on certain parameters like device tags.