Introduction to REST API
A quick introduction to our REST API and how to get started using it.
Our REST API can be used to interact with our services programmatically. For instance, DT Studio, our easy-to-use device management web app, is itself entirely built upon the REST API. Therefore, everything you can do in DT Studio, from moving devices between projects and managing Service Accounts, can also be done via our REST API.
The only thing you need to get started using our REST API is a Service Account with sufficient permissions for the task you want to do. While subsequent Service Accounts can be managed through the REST API itself, the initial account must be set up using DT Studio as an entry point.
Once in possession of a Service Account, a comprehensive list of every endpoint available can be found in our REST API Reference documentation.
All our REST API calls are extensions of a base URL used in either long- or short-form.
This is also true for our Sensor Emulator API, an extension for the main REST API under a separate URL.
Our REST API supports two methods of authentication, both using a Service Account for access control.
- Basic Auth: A simple username- and password-style authentication, handy for quick prototyping.
- OAuth2 Flow: A robust exchange of credentials for an access token used to authenticate.
We recommend using the OAuth2 authentication flow when integrating with our REST API. Once implemented, OAuth2 makes sending HTTP Requests both simple and secure.