ADI OtoSense REST API

Introduction

L'API REST d'ADI OtoSense SMS fournit un large éventail d'opérations et de ressources qui :

  • Permet d'approvisionner les moteurs équipés de capteurs de moteur intelligents.
  • Accède à des ensembles de données motorisées, y compris des résultats analytiques.
  • Récupère les détails de l'alerte moteur, y compris les enregistrements historiques.

Accès à l'API

Si vous avez un locataire ADI OtoSense SMS, vous pouvez accéder à l'API REST d'ADI OtoSense SMS via le point de terminaison API de votre locataire. Votre point de terminaison peut être trouvé dans l'interface Web d'ADI OtoSense SMS, sur l'écran API - Points de terminaison qui est accessible via l'option API dans le menu sous votre nom en haut à droite de l'écran.

Si vous n'avez pas de locataire ADI OtoSense SMS, allez sur otosense et inscrivez-vous pour un locataire d'essai de production.

Authentification

L'API REST d'ADI OtoSense SMS utilise OAuth v2.0 pour l'authentification.

Analog Devices recommande une approche de moindre privilège pour les utilisateurs de l'API. Veillez à n'attribuer aux utilisateurs de l'API que des rôles avec le niveau de privilège le plus bas.

L'authentification via OAuth nécessite les étapes suivantes :

  1. Créer une clé API client.
  2. Générer un jeton.
  3. Effectuer des demandes authentifiées.

Créer un client

Vous devez d'abord créer une clé API dans l'interface utilisateur d'ADI OtoSense SMS. Pour ce faire, vous devez être administrateur de votre locataire ADI OtoSense SMS. Il s'agit d'une opération unique. Vous recevrez un identifiant et un secret client. Veuillez noter ces informations, car elles seront nécessaires pour l'étape suivante. L'identifiant et le secret du client doivent être considérés comme des informations d'identification sensibles et doivent donc être sécurisés de manière appropriée. Ne les utilisez jamais dans des applications frontales à page unique, ne les intégrez jamais au code source et ne les rendez pas accessibles à tous.

Remarque : la clé API est régie par le rôle attribué à l'utilisateur. Les opérations disponibles pour la clé seront déterminées par ce rôle.

Consultez la version complète de l'API REST d'ADI OtoSense ici.