# 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[ ](https://aranet.cloud/openapi/)[**Swagger**](https://aranet.cloud/openapi/) 
* 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:\
    

   <div data-with-frame="true"><figure><img src="https://forum.aranet.com/site/assets/files/3910/ac_integr_write.jpg" alt=""><figcaption></figcaption></figure></div>
2. Navigate to the **SETTINGS** menu and select **API** tab:

A brief API key description and [link to complete Aranet Cloud API documentation](https://test.aranet.cloud/openapi/)[ ](https://aranet.cloud/openapi/), as well as the list of created keys, are here.

<div data-with-frame="true"><figure><img src="https://forum.aranet.com/site/assets/files/3910/screenshot_2023-03-01_102806.1369x0-is.jpg" alt=""><figcaption></figcaption></figure></div>

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

<div data-with-frame="true"><figure><img src="https://forum.aranet.com/site/assets/files/3910/ac_api_02.jpg" alt=""><figcaption></figcaption></figure></div>

4. 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)**.

<div data-with-frame="true"><figure><img src="https://forum.aranet.com/site/assets/files/3910/ac_api_03.jpg" alt=""><figcaption></figcaption></figure></div>

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

<div data-with-frame="true"><figure><img src="https://forum.aranet.com/site/assets/files/3910/screenshot_2023-03-01_103407.1335x0-is.jpg" alt=""><figcaption></figcaption></figure></div>

<div data-with-frame="true"><figure><img src="https://forum.aranet.com/site/assets/files/3910/ac_api_05.jpg" alt=""><figcaption></figcaption></figure></div>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.aranet.com/aranet-cloud-page/aranet-cloud-landing-page/integrations-and-extensions/cloud-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.