For the complete documentation index, see llms.txt. This page is also available as Markdown.

Cloud API

Aranet Cloud API allows access to the sensor and cloud data outside of the Aranet ecosystem. Cloud API is a Pull-type integration. By using the Aranet Cloud API, Aranet Cloud can be integrated with any other web or cloud-based IT system or used as a data source for 3rd-party applications.

The main features of Aranet Cloud API:

  • Centralized data access for all the necessary sensors via a single connection

  • Pull-type API integration providing access to data in Aranet Cloud

  • On-demand data access from Aranet Cloud without the need to establish data storage on a 3rd-party IT system

  • Ability to request current, latest, and specified period data

  • Access to cloud-specific data like virtual sensors, alarms, assets

  • Authorization using API key

  • API documentation – all currently available endpoints are documented via Swagger

  • Supported data format: JSON

Currently implemented Aranet Cloud API:

  • supports only GET requests, meaning that the 3rd-party system shall not be able to insert or update any data into the Aranet Cloud database;

  • following data can be requested:

    • sensor measurements (with UTC timestamps)

    • sensor list with sensor details (name, interval, sensorID, type)

API key:

  • Each 3rd-party system receives its own API key, which is used to authenticate data requests.

  • One API key authenticates to only one Aranet Cloud workspace.

  • By default, the API key has the same units configuration as the user who creates it.

  • A key value must be 32 characters long.

Last updated