Sigfox Cloud Integration

In order to control and manage your devices on the Sigfox network, we have developed a fully integrated Cloud platform, which you can very easily integrate with your  own platform or server. 

To create a link between our platform and your servers, we have established 2 ways of communicating in order to answer all customer requirements: "Callbacks", and "Rest API". 


Introduction

To understand the main difference between these two ways of communication with your server, you toned to understand the way the Sigfox Cloud has been built. 

On Sigfox Cloud a company is usually represented by a "Group", in which numerous "Device types", can be attributed to a "family" of devices. All units from the same product will be grouped by device type to allow all them to behave exactly in the same way when a message is received by the Sigfox network. 

This is represented in the diagram below: 

Each device type can generate "Callbacks" to push data to your server when a message is received by our network from one of the devices present in this device type.  

Callbacks are HTTP requests which are one way only, as they are generated by our server and send to your servers instantly upon receipt of a message is received. 

We have also set up a Rest API mechanism which works at Group level, and which is bi-directional. Integrating our API into your applications will allow you to request information from our servers from the devices registered on our network, at any time you need it. 

This will also allow you to manage, deploy and declare all your devices on the Sigfox Cloud platform, completely automatically, thus removing the necessity to connect continuously to our Cloud platform to perform recurring operations such as callback declarations, device management, etc. This is used by our customers to handle the huge volume of devices they register on our network, directly from their platform. 

Callbacks

Callbacks are available through device types as they will be activated every time any device from this device type sends a message. The callback menu is available when clicking on the "Device type"  tab, and then clicking on any device type you have. The callback menu will appear on the left. 

If you select the callback menu and click on "new" on the top right corner, different options will appear.

There are 2 types of callback : The "built-in" callback where some of our partner platforms are natively integrated, and the "Custom" Callback where you can integrate your own. 

Built-in callbacks

 Today the platforms that are available “natively” are:

      This list is evolving

Custom callbacks

If you wish to instantly send incoming messages to your private server or to a custom service, you will have to complete information regarding the service (is it for UPLINK or DOWNLINK?, the URL pattern, payload parameters etc...).

In this way you will be able to process data sent from the device server-side and render the information gathered intelligible for the end user (after decoding the hexadecimal frame).

Below is a document describing callback configuration in details.

More Resources on callbacks

REST API

After the setup of the HTTP Callbacks, you will quickly be able to retrieve messages on your private application. But.. 

  • How do you manage your huge list of devices ? 
  • How can you automaticaly register new devices when a customer activates a new one ? 
  • How can you know there is Sigfox coverage at a designated location  ? 

We have setup a very powerful REST API which will allow you to automate every required action. This was done to allow our customers to completely manage the Sigfox aspects of their business separately from their own platforms. 

To get access to this API, you need to create an API Access token for yourself. To do so, click on your group, and navigate to the "API Access" tab on the left. 

Below is a document describing the different endpoints available and how to access them.

Note : The documentation available for download was made for Customer API access. Your access rights may have limitations depending on your credentials. 

More Resources on the API

More resources