To understand the main difference between these two ways of communication with your server, you need to understand how the Sigfox Cloud was built.
On Sigfox Cloud a company is usually represented by a "Group", which contains "Device type". Each device type can be attributed to a "family" of devices. All units of the same product will be grouped as a device type to allow all of 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 a third-party server, such as your own platform. When a message is received by our network from one of the devices of this device type, the callback sends it over to your server.
Callbacks are HTTP requests which are one-way only, as they are generated by our server and sent to your servers instantly upon receipt of a message from the emitting device.
We also set up a REST API mechanism which works at Group level and is bi-directional. Integrating our API into your applications will allow you to request data from our servers. This data comes from the devices registered on our network. You can make requests any time you need it.
This will also allow you to manage, deploy and declare all of your devices on the Sigfox Cloud platform, completely automatically. This removes the necessity to continuously connect to our Cloud platform to perform recurring operations such as callback declarations, device management, etc. This is used by our customers to handle, directly from their platform, the huge volume of devices they register on our network.
Callbacks are available through device types, as they will be activated every time any device of this device type sends a message.
To create a callback, open the callback menu in Sigfox Cloud. It is available by 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" in the top right corner, different options will appear.
There are two types of callback methods: The "built-in" callback, where some of our partner platforms are natively integrated, and the "custom" callback where you can integrate your own.
Currently, the platforms that are available natively are:
More to come!
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?
- What is the URL pattern,
- What are the payload parameters
By doing so, you will be able to process data sent from the device server-side and render the information gathered intelligibly for the end-user -- after decoding the hexadecimal frame.
Below is a document describing callback configuration in details.
API v1 is deprecated since the release of SIGFOX Cloud 7.8 on October 29th of 2018. It will still work until sunset date, on September 30th of 2019. You have one year to migrate existing codes written on API version legacy (V1) to API version 2.
After setting up 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 automatically register new devices when customers activate them?
- How can you know there is Sigfox coverage at a designated location?
We have built 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 autonomously from their own platforms.
To access this API, you need to create an API Access Token for yourself. To do so, when logged on Sigfox Cloud, click on your group, and navigate to the "API Access" tab on the left.
Below is the API v2 apidoc (in OpenAPI format), describing the different endpoints available and how to access them.