ADI OtoSense REST API

Einführung

Die ADI OtoSense SMS REST API bietet eine breite Palette von Operationen und Ressourcen, die:

  • Ermöglicht die Bereitstellung von Motoren, die mit intelligenten Motorsensoren ausgestattet sind.
  • Zugriff auf Motordatensätze einschließlich analytischer Ergebnisse.
  • Ruft Details zu Motorwarnungen einschließlich historischer Aufzeichnungen ab.

Zugang zur API

Wenn Sie einen ADI OtoSense SMS-Tenant haben, können Sie auf die ADI OtoSense SMS REST API über den API-Endpunkt Ihres Tenants zugreifen. Ihren Endpunkt finden Sie in der ADI OtoSense SMS Web UI auf dem Bildschirm API - Endpunkte, auf den Sie über die Option API im Menü unter Ihrem Namen oben rechts auf dem Bildschirm zugreifen können.

Wenn Sie noch keinen ADI OtoSense SMS-Tenant haben, gehen Sie zu otosense und melden Sie sich für einen Production Trial-Tenant an.

Authentifizierung

ADI OtoSense SMS REST API verwendet OAuth v2.0 zur Authentifizierung.

Analog Devices empfiehlt für API-Benutzer einen Ansatz mit möglichst geringen Rechten. Stellen Sie sicher, dass Sie allen API-Benutzern nur Rollen mit der geringsten Berechtigungsstufe zuweisen.

Für die Authentifizierung über OAuth sind die folgenden Schritte erforderlich:

  1. Erstellen Sie einen Client-API-Schlüssel.
  2. Erzeugen Sie ein Token.
  3. Authentifizierte Anfragen stellen.

Einen Kunden erstellen

Sie müssen zunächst einen API-Schlüssel in der ADI OtoSense SMS UI erstellen. Dazu müssen Sie ein Administrator Ihres ADI OtoSense SMS-Tenants sein. Dies ist ein einmaliger Vorgang. Sie erhalten eine Client ID und ein Client Secret. Bitte notieren Sie sich diese Informationen, da sie für den nächsten Schritt benötigt werden. Die Client-ID und das Client-Geheimnis sollten als sensible Anmeldedaten betrachtet und daher entsprechend gesichert werden. Verwenden Sie sie niemals in einseitigen Front-End-Anwendungen, übertragen Sie sie niemals in den Quellcode oder machen Sie sie anderweitig allgemein zugänglich.

Hinweis: Der API-Schlüssel wird von der zugewiesenen Benutzerrolle bestimmt. Die für den Schlüssel verfügbaren Operationen werden durch diese Rolle bestimmt.

Die vollständige Version der ADI OtoSense REST API finden Sie hier.