API integration best practices

API integration best practices

Our sensors measure water, which is the reason why they are blue. We believe that sensors are always part of an ecosystem and that for different purposes, different (combinations of) parameters need to be measured. That is why the Sensoterra sensors are built to integrate with platforms and other systems. We like to say: “our API is our platform”. This post describes integration best practices with the Sensoterra REST API and HTTP Push notifications.



Our sensors measure water, which is the reason why they are blue. We believe that sensors are always part of an ecosystem and that for different purposes, different (combinations of) parameters need to be measured. That is why the Sensoterra sensors are built to integrate with platforms and other systems. We like to say: “our API is our platform”.

This post describes integration best practices with the Sensoterra REST API and HTTP Push notifications. Once the payloads are decoded and calibrated in our backend, this is the preferred option to integrate the data from our sensors. The system has been designed to give you maximum control and flexibility.

Retrieving data

Using your own credentials, it is possible to retrieve (pull) data using the REST API. Through this API, your sensor numbers, readings and other parameters can be retrieved. Because polling can cause stress on both sides, especially with higher numbers of sensors, we advise you to create an endpoint in your own backend which we can use to forward sensor readings to, in near real-time. If you use HTTP Push, automatically all readings are forwarded for all sensor ID’s under your account!

Hierarchy

If you have a reseller account with linked customer accounts, you can also retrieve measurements of your customers’ sensors by accessing the API through your reseller account. This means you don’t have to login with the credentials of your customers. When HTTP Push is set up for a reseller account, all measurements from sensors from underlying customer accounts will be forwarded as well. Of course, there is also a call to see your customer list and which sensor numbers are linked to which of your customers.

Registering probes and changing settings

When integrating, you need to have full control over the system. This is why it is possible to register (add) new probes through the API, and also to update the settings like soil calibration, naming and geo location. Of course, when designing your platform, it’s up to you where you record which information – but it’s even possible to create new user accounts under your reseller account in Sensoterra through the API.

Note: in principle, the Sensoterra web monitor and phone apps do not need to be use with a full API integration. However, because the monitor apps use the same API, hybrid use is possible.

Retrieving lists of parameters

Because for example sensor types are added or soil calibrations are maintained and expanded centrally, you can always do a call to retrieve lists of parameters (for example a list of calibrations). This way you can always make sure your platform integration benefits from the latest developments at Sensoterra side.

Getting started

All calls and model code can be found on the API Swagger page. For more detailed information, check our Moisture Data Integration guide.