API REST de ADI OtoSense

Introducción

La API REST de ADI OtoSense SMS proporciona un amplio conjunto de operaciones y recursos que:

  • Permite el aprovisionamiento de motores mejorados con sensores de motor inteligentes.
  • Accede a conjuntos de datos de motores, incluidos los resultados analíticos.
  • Recupera los detalles de las alertas de motor, incluidos los registros históricos.

Acceso a la API

Si tiene un tenant de ADI OtoSense SMS, puede acceder a la API REST de ADI OtoSense SMS a través del punto final de la API de su tenant. Puede encontrar su punto final en la interfaz web de ADI OtoSense SMS, en la pantalla API - Puntos finales a la que se accede a través de la opción API en el menú bajo su nombre en la parte superior derecha de la pantalla.

Si usted no tiene un inquilino ADI OtoSense SMS, vaya a otosense y regístrese para obtener un inquilino de prueba de producción.

Autenticación

ADI OtoSense SMS REST API utiliza OAuth v2.0 para autenticar.

Analog Devices recomienda un enfoque de mínimos privilegios para los usuarios de API. Asegúrese de que solo asigna funciones con el menor nivel de privilegios a los usuarios de API.

La autenticación a través de OAuth requiere los siguientes pasos:

  1. Cree una clave API de cliente.
  2. Generar un token.
  3. Realizar solicitudes autenticadas.

Crear un cliente

Primero debe crear una clave API en la interfaz de usuario de ADI OtoSense SMS. Para ello, debe ser administrador de su inquilino ADI OtoSense SMS. Esta operación se realiza una sola vez. Se le proporcionará un ID de cliente y un secreto de cliente. Por favor, anote esta información, ya que será necesaria para el siguiente paso. El Client ID y el Client Secret deben ser considerados credenciales sensibles y por lo tanto deben ser protegidos apropiadamente, nunca los utilices en aplicaciones front-end de una sola página, nunca los comprometas con el código fuente o los hagas accesibles al público en general.

Nota: La clave API se regirá por el rol de usuario asignado. Las operaciones disponibles para la clave estarán determinadas por este rol.

Vea la versión completa de la API REST de ADI OtoSense aquí.