search

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 arrow-up-rightSwaggerarrow-up-right

  • 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.

To create an Aranet Cloud API key:

  1. Log in to the Aranet cloud as a user having Integrations Write permissions:

  2. Navigate to the SETTINGS menu and select API tab:

A brief API key description and link to complete Aranet Cloud API documentationarrow-up-right arrow-up-right, as well as the list of created keys, are here.

  1. Click on CREATE NEW button, new pop-up window will open:

Enter API account name a), Description b) and key expiration date (in needed) c). Press CREATE button.

  1. The pop-up window will change:

You will see the generated API key d), which can be copied to the clipboard by pressing button e). API key expiration date can be adjusted f), then the key can be SAVED or DELETED. If no changes are needed, close the window g).

  1. The updated API tab with the new key in the list opens: You can review the API key log file by pressing on "clock" button, or edit it by clicking on the "pencil" button.

Last updated