API Overview

API Overview

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

We have a comprehensive set of APIs that gives 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 do all the same things directly using API.

Acces the API documentation.

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

Looking for our SDK ?

All responses from TagoIO API have a pattern, and you will always receive something like this:

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

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

// For failed:
{
        'status': false,
        'message': 'Error message'
}

status: it is always boolean. If your request is successful the response will be true, otherwise it will be false.

result: can be any object type (that is dynamic object), depends what api endpoint you called for.

message: it is a message from the server. Usually it is used when has any error or warning.

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 between the devices, your application, and TagoIO server is performed through Hypertext Transfer Protocol Secure (HTTPS) to avoid the man-in-the-middle and wiretapping attacks.

Although the communication can also be performed with HTTP, TagoIO doesn’t recommend it. By doing so will eliminate the security of authentication and encryption provided by SSL/TLS protocols part of HTTPS. Just in case you really need to use HTTP without SSL, all you have to do is to add _ssl=falseon the header or url query string.

Secret tokens for account and devices are generated by TagoIO system and can be individually managed by the user. Different levels of access can be granted to different users or devices.

The URL that your device should connect is https://api.tago.io/data through Port 443.

Learn how to access TagoIO also using Static IP.

Tokens

There are four type of tokens: Account-TokenDevice-TokenAnalysis-Token and Middleware-Token.

You are able to generate all tokens from TagoIO admin or directly using API. The type of token and its expiration can also be defined. Just add them in the header of your the http request.

HEADER KEYHEADER VALUE
Account-TokenOnly Account Token
Device-TokenOnly Device Token
Analysis-TokenOnly Analysis Token
Middleware-TokenOnly Middleware Token
Authentication Any Token (Account or Device)

 

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


    • Related Articles

    • RESTful API

      We provide a powerful set of Restful API documentation that's used by Analysis behind the scenes to perform all sorts of requests to TagoIO, such as but not limited to: Creating, deleting and editing devices Creating, deleting and ...
    • Connector Overview

      Connectors enable you to create a device with built-in behaviors that allow it to communicate with a Network very easily. They also help you automate and scale your devices, once you create a device using a connector, that device will also run the ...
    • Analysis Overview

      Analysis is a powerful feature that experts and developers can use to implement scripts to analyze and manipulate data from any device in real-time. The scripts that run at TagoIO are programmed with the Node.js TagoIO's SDK. Get more instructions on ...
    • Gauge Overview

      Gauge contains a collection of metric widgets. You can choose among several types of Gauges that will present the last value of a variable in different formats. Dial Dials are one of the simplest and more useful widgets. They make it easy to ...
    • Widgets Overview

      Dashboards are composed by widgets that can display and collect data from users. TagoIO provides a variety of widgets to handle your data in real time. The available options cover from simple dials to tables, maps, videos, and even forms that you can ...

    Aug 30 - Join us at TagoIO Connect, our annual conference. Learn new features and use cases. Register Here


      Future and past Webinars