To integrate any kind of third party device or third party data resource with

There are some projects that require the integration of third-party data sources, such as a Cloud Service, devices without library on it source code, or a custom program. In this section it is explained how to use the "HTTP device" profile at, that allows receiving data via REST API from whatever source that is able to create a connection with Server and send an HTTP request, taking advantage of all features such as display real-time data in dashboards, store in data buckets or process it using a plugin.

This integration provides bidirectional communication between and the data source by making use of HTTP request and response data, which consist of basic HTTP POST messages with JSON codified data.

Note that this integration can't explode the 100% of features and benefits in terms of communication efficiency, real-time data and device administration, so it is strongly recommended integrating the devices using the software client if it is available.

In the next sections, it is explained how to create and configure the HTTP Device Profile at Platform and how to link it with the data source.

Creating HTTP Device Profile

First step to work with this interface consists of creating the device profile at the "devices" main menu tab and clicking on "new device" button. Then, select "HTTP Device (Sigfox, Lora, cURL)" type and fill Device ID and Description slots as required.

Ones the profile has been created it is possible to found it at the devices list, then, clicking the device identificator will open the "device dashboard", which is an interface that show device status and connection information and also allows working with the callback configuration and properties.

However, when time this page is first accessed (before making the first call to the REST API) there won't be any information to show o it will have the same aspect as the previous image. Note that this interface contains two additional tabs: the "Callback" tab allows managing the device behavior and capacities, each of these features will be explained in the "Managing Callback Functionalities" section of this document. On the other hand, the "Properties" tab allows to create and manage device properties, which are variables related with this device stored in Server, that can be edited, displayed, or forwarded to the device using callback menu functionalities.

Building the HTTP request

It is necessary to obtain the HTTP request and the authorization that allows interacting with and start sending data from an external system. Clicking into "Callback" tab, it is possible to show all callback details and builds the request in a simple way, as explained in the next steps:

1) Going to Callback / Settings tab, check the "authorization" box. A bearer token will appear into this section.

2) Then, going to Callback/Overview tab, an specification of the REST API that provides access to this device will be shown, ready to be copied into the program or HTTP request entry.

After follow the first step, the authorization token that is shown on this interface will be fixed, being also the same as the one shown at "settings" tab, so it can be copied too in order to create the HTTP Request.

3) Now the system is ready to start sending data to via HTTP request, however, note that this system is aimed to receive application/JSON data codified messages. If the system messages do not contain JSON data the server will answer with a 200 OK message to the communication but no data will be stored. The image below shows an example of well defined JSON in the bottom of this tab:

Managing Callback Functionalities

Ones the callback has been integrated with the system, the developer will be able to use almost all Platform features by selecting it into Callback/Settings tab. In the next section shows a complete specification of the features that can be exploit:

Store data in Buckets data Buckets is a scalable system that allows storing devices data in a simple way. Allowing support for historical data analysis or download IoT data into a file. The Callback manager allows associating an existent data bucket to the HTTP Device data in order to store it as is retrieved.

To make this assignment, just check the checkbox and click into the text entry to select or search a previously defined data bucket as shown in the previous image.

Call Endpoints allows defining endpoint profiles that simplifies the execution of a service such as sending an email, send a SMS, call a REST API, interact with IFTTT, call a device from a different account, or call any other HTTP endpoint.

The Callback Manager allows to easy associate the device data with a previously defined Endpoint profile that will be called in real time when the data is processed by server.

Set device properties

This feature provides an easy way to select a property of this device in order to store just the last-received data from a device or set an specific attribute such as location data. This feature allows using server as a persistent memory for the device. To select the property that will be modified just select the checkbox and find it's ID in the text entry.

The device properties can also be shown and managed by just going to "Device Properties" tab of the device dashboard.

HTTP Response Data

HTTP communications allows sending data to the device in the confirmation message, this feature can be use to create bidirectional communication with these kind of devices using the "Response Data" section of the Device Callback management interface.

To start sending response data, just click over the Check-box and select a device property from the list as shown in the image blelow:

This feature is aimed to introduce an existent device's property into the HTTP response, so if there is not any previously created property, the first step will be adding a new one using the "Properties" menu.

Note that there device properties will be sent using JSON content type, so the device codification has to be ready to retrieve and work with this data.

Connection Timeout

This parameter allows to establish a device connection timeout in minutes, so the platform can consider the device as "disconnected" after a fixed time without receiving messages.

Building the HTTP request in the data source

Finally it is necessary to introduce the API given in the "callback overview" section in the system or device, allowing to connect with the platform and start sending data. If everything is done correctly the device dashboard will start displaying information as shown in the image below:

As there are different ways to make this integration, in this section it is explained how to properly implement the request over different supports.

Coding the request

For those users that needs creating the complete HTTP request manually, the next segment shows how to make this properly. Note that the request body is formed following the next schemma: REST API + ?authorization= + Token

Using Postman / HTTP request manager

This services provide a useful way to test HTTP integrations in a simple way. It is only necessary to follow the next steps to configure a request:

  1. Select <POST> message type

  2. Introduce the device callback into the main textbox

  3. Create an Authorization header with "bearer" command

  4. Create a Content-type header with application/json type

  5. Write some valid JSON data and send your query

As shown in the previous image, you should receive an empty 200 OK status message.

Using cURL

If the source system supports cURL instructions, there is an integration example into Callback / Curl tab, ready to copy and modify:

Last updated