Skip to main content

API Overview

It is easy to connect devices, data sources, or third‑party apps to your account using the TagoIO Application Programming Interface (API).

We provide a comprehensive set of APIs that give you full control to manage your accounts, data, devices, dashboards, and scripts. You can use the resources available in the Admin page to create, delete, or edit your accounts and dashboards; however, you can perform all the same actions directly using the API.

Access the API documentation.

We follow RESTful principles. Before checking the API documentation, there are a few details you should know.

tip

Looking for our SDK?

API response pattern​

All responses from the TagoIO API follow a consistent pattern. You will typically receive responses similar to the examples below:

// For success:
{
  "status": true,
  "result": [...]
}

// For warning:
{
  "status": true,
  "result": {...},
  "message": "Warning message"
}

// For error:
{
  "status": false,
  "result": {
    "message": "Error message"
  }
}

For more details and endpoints, refer to the full API documentation and the SDK page above.

Security​

TagoIO takes the necessary steps to protect your data in the database and also during the communication between our server and your devices.

All communication is performed through Hypertext Transfer Protocol Secure (HTTPS) to avoid man‑in‑the‑middle and wiretapping attacks. Although HTTP can be used, it is not recommended because it removes the security of authentication and encryption provided by SSL/TLS protocols that are part of HTTPS. If you must use HTTP without SSL, add _ssl=false in the header or URL query string.

Tokens​

There are four types of tokens: Account‑Token, Device‑Token, Analysis‑Token and Middleware‑Token. You can generate all tokens from the TagoIO admin or directly using the API. The type of token and its expiration can also be defined. Add them in the header of your HTTP request:

Header KeyHeader ValueAccount-TokenOnly Account TokenDevice-TokenOnly Device TokenAnalysis-TokenOnly Analysis TokenMiddleware-TokenOnly Middleware TokenAuthenticationAny Token (Account or Device)

Check the usage policy based on the number of requests per a certain period.

Regional endpoints​

When making a request to the TagoIO API, you must also specify the appropriate regional endpoint. The device data URL is https://api.<region>.tago.io/data through port 443. For other regions use:

https://api.<region>.tago.io/

Check out the available regions in the API documentation.