Sub-Menu: Homepage
Sub-Menu: Smart Motor Sensor
Sub-Menu: Quality Control

ADI OtoSense REST API

Introduction

The ADI OtoSense SMS REST API provides a broad set of operations and resources that:

  • Enables provisioning of motors enhanced with Smart Motor Sensors.
  • Accesses motor data sets including analytical outputs.
  • Retrieves motor alert details including historical records.

Access to the API

If you have an ADI OtoSense SMS tenant, you can access the ADI OtoSense SMS REST API via your tenant's API endpoint. Your endpoint can be found in the ADI OtoSense SMS Web UI, on the API - Endpoints screen which is accessed via the API option in the menu under your name on the top right of the screen.

If you do not have an ADI OtoSense SMS tenant, go to https://otosense.analog.com and sign up for a Production Trial tenant.

Authentication

ADI OtoSense SMS REST API uses OAuth v2.0 to authenticate.

Analog Devices recommends a least privilege approach to API users. Ensure you only assign roles with the least level of privilege to any API users.

Authenticating via OAuth requires the following steps:

  1. Create a Client API Key.
  2. Generate a Token.
  3. Make Authenticated Requests.

Create a Client

You must first create an API key in the ADI OtoSense SMS UI. To do this, you must be an administrator of your ADI OtoSense SMS tenant. This is a one-time operation. You will be provided with a Client ID and a Client Secret. Please note this information down, as it will be required for the next step. The Client ID and Client Secret should be considered sensitive credentials and thus should be secured appropriately, never use them in front end single page applications, never commit them to source code or otherwise make them generally accessible.

Note: The API key will be governed by the assigned user role. The operations available to the key will be determined by this role.

View the full version of the ADI OtoSense REST API here.

Read More