Guides

Getting started with APIs

End Customer API access

Overview

The API is designed to be RESTful, supporting standard HTTP methods such as GET, POST, PUT, and DELETE for interacting with resources.

Authentication & Authorization

All API requests must be Authorized via Headers using a Core API Keys.

Additional APIs

A number of additional APIs are available to select tiers, please contact support at [email protected] for additional information.

Pagination

APIs that return large data sets, might require the use of Pagination.

Error Codes

  • 401 Unauthorized: the api_key is not provided or is invalid.
  • 403 Forbidden: the user does not have permission to perform the requested action.
  • 404 Not Found: a device with the specified ID is not found.
  • 422 Unprocessable Entity: a required parameter is missing or invalid.

Postman

A full Postman collection is available for download: Postman Collection