The Sensor Data Platform supports data in JSON (application/json MIME type) and XML (application/xml MIME type) format.
When configuring new sensors, it is highly recommended to use the Desktop Utility Application (Windows only).
There are no constraints with respect to structure of data because the usage of Avro schemas. The platform also supports nested data.
Note: It is recommended to follow the ISO/IEC 21778:2017 JSON standard.
An organization or company that administrates the sensors or who are the responsible. Must be created prior to obtaining a valid access token.
The access token (or just token) is used for authorizing access to several REST endpoints in this API.
A physical hardware unit that monitors one or more physical quantities (e.g. PM10, PM2.5, temperature, relative humidity, ..).
A physical quantity monitored by the sensor (e.g. PM10, PM2.5, ..).
A document in JSON or XML format either generated directly by embedded software in sensor, or indirectly by other hardware and software. This document contains the components and their corresponding measurement values.
Link between one of the sensor components defined in the data packet and a component defined in the data platform. Used during the data harmonization.
Link between one of the sensor components/attributes defined in the data packet and a converter or a field mapper Used during the data harmonization.
Used when one of the sensor components defined in the data packet needs to be transformed to a numeric value. Used during the data harmonization.
Used when the data packet contains timestamp information. If timestamp mapping is not possible, then the system UTC datetime will be used.
NOTE: An example on how to use the converter and field mapping concepts can be found here.
A REST (desktop) client utilizing this REST API. Helpful for creating sensor schema which can be tricky if data packet contains nested structures. Still under development. A web interface is also under development, and can be found here.
A standard that can be used to describe the structure of a sensor data packet. Used for data validation.
Curl is a client tool to transfer data from or to a server, using for example the HTTP or HTTPS protocol.
When interacting with the REST API during sensor schema configuration, etc., we strongly advice you to use a "pure" HTTP client like the cURL application.