Introduction
A general overview of the integration services available for Airthings for Business' customers
Integration services
The Airthings for Business’ integration services offer the possibility to collect and use the data provided by the Airthings cloud for any desired purpose. There are currently three different integration options to choose from; RESTful API, Webhooks and MQTT, all of which are available for any Airthings for Business account with an active subscription.
The documentation provided in this developer-page aims to help you learn how to utilize each service most efficiently. From setting up clients, authenticating and making requests, to parsing responses - our guides cover everything you need to know to be able to integrate the data we provide into your applications seamlessly. Whether you're a beginner or an advanced developer, our examples and best practices will help you make the most out of our integrations.
Selecting which service to use is entirely up to you, and it depends on the purpose of your application, as well as its capabilities. Using a combination of the integration services is highly recommended if you’re able to, as it will provide each of the service's benefits for their purposes.
RESTful API
The Airthings for Business RESTful API offers the possibility to interact with the Airthings platform and request data or perform actions - like adding devices, adding locations, or managing your Webhooks. You can use the API to request information about devices or locations in your account, and you can also request historical data from any device.
The latest available samples can be requested per device, or for all devices in a location in one single request, but it is recommended to use Webhooks or MQTT if you’d like to receive the data immediately after it’s been made available.
Webhooks
A webhook client can be created and managed either by using the Airthings for Business Dashboard or the API. Webhooks offer the possibility to receive data immediately after it’s been processed by the Airthings cloud, and there are events available from Hubs and virtual sensors in addition to samples from the physical sensors in devices.
If you want to use data received from webhooks for analytics or other functions where you need to ensure that you have all the processed data available, we recommend also using the API at certain intervals to retrieve historical data and refresh your database.
MQTT
MQTT is the most lightweight and simple way to receive data from Airthings devices. It offers the possibility to subscribe to data from devices in an Airthings for Business account, and ensures that data is sent to the connected client as soon as it’s been processed. MQTT is the most popular service for on-site solutions, like Building Management Systems (BMS), since it grants a secure connection to the cloud to receive data without having to allow incoming requests to the network.
Like with webhooks, we recommend also using the API at certain intervals to retrieve historical data and refresh your database if you plan on using the data for analytics or other purposes where you need to ensure that you have all of the processed data available.
Getting started
Feel free to browse each section of the developer page, and use any guides available to help you get started properly. We strongly advise that you start by reading the concepts page, as well as using that page actively as a reference, to get a complete understanding on how the data is structured within the Airthings platform.
New guides and documentation are continuously being added to the developer page, and you can check in on the changelog for each service to see if any updates have been made to any of them recently.
Updated 5 months ago