Account API
Introduction
Release 3.0 of DeviceHQ® will support a json-format, token-authorized Account API designed for automated access to account and device information to any user with a valid DeviceHQ account.
Prerequisites
To use the API it is necessary to have an enabled, valid DeviceHQ account. It is not necessary to own any MultiTech devices or have had any devices checked-in to the DeviceHQ server.
In order to enable API access for their account information, users must generate an Account API Key, and enable API access.
Enabling API Access
To enable API access:
- Log in to devicehq.com with manager-level access.
- Click on the user email in the upper right corner.
- Click on Account Info and then click Edit.
- Check Account API Enabled.
- Click Update Account and return to the edit screen.
Generating API Keys
An account API key is like a password for your account on deviceHQ.com. The account API key (not the same as the account key) allows the API client to access the account with the same privileges as a manager-level user belonging to that account.
To generate API keys:
- Log in to devicehq.com with manager-level access.
- Click on the user email in the upper right corner.
- Click on Account Info and then click Edit.
- Click Generate New Account API Key (as needed).
DeviceHQ generates new keys for access to the account API.
Notes:
- MultiTech recommends you save the generated keys in a safe place, as they will not be displayed again as they are stored using a 1-way cryptographic hash algorithm.
- New keys may be generated at any time.
- Generating new keys will invalidate any key that had previously been generated.
- At any given time, only 1 client per account can have a session open.
Account API – Search and Pagination