API Keys

Before you can use the API you need a valid API key.

An API key is a 64 byte (512 bit) string that is generated by the DeviceTone™ system and enables access to a specific scope in the system - a user, a device, a project or a company.

There are five ways to get a valid API key:

  1. After using the Subscribe User API, the user will get a user API key that allows the user access to devices owned by that user or to devices that user got permissions for.
  2. Using the Login API with valid credentials returns the User API key. This is the main method of interacting with the back-end from a mobile app.
  3. An IoT device can send an Activate API request with a valid activation key and would get back its Device API Key. This is the main method of interacting with the back-end from an IoT device.
  4. The DeviceTone™ Manager –> Profile page displays the list of API keys that the user owns. These API keys allow access to different scopes of devices - Project API keys, Company API keys (for company super users) or User API keys.
  5. The DeviceTone™ Manager –> Device page –> Configuration sections displays and allows creating Device API keys. These are the keys an IoT device uses to interact with the back-end.