API-Zugangsdaten generieren

API-Zugangsdaten generieren

Dieser Artikel enthält eine Schritt-für-Schritt-Anleitung für die Generierung und Verwaltung von API-Zugangsdaten für das Lenovo Device Operations (LDO)-Portal. Folgende Prozesse werden erörtert: Erstellung von Client-ID und geheimem Schlüssel, Abrufen eines Bearer-Tokens für die Authentifizierung und Zugriff auf verschiedene API-Endpunkte. Darüber hinaus wird erläutert, wie Sie die Swagger-Dokumentation verwenden, um die verfügbaren API-Methoden zu erkunden und zu testen.
Notes
Sie müssen über ein Organisationsadministrations-Konto im LDO-Portal verfügen, um 
API-Zugangsdaten generieren zu können.

API-Zugangsdaten generieren

Bevor Sie LDO-APIs verwenden können, müssen Sie API-Anmeldeinformationen in Ihrem LDO-Konto generieren. Führen Sie die folgenden Schritte aus:

  1. Klicken Sie im Dropdown-Menü der oberen Navigationsleiste auf Geräte-Insights.


  2. Navigieren Sie zu Konfiguration/Geräte-Insights-Einstellungen.


  3. Klicken Sie auf API-Zugangsdaten, um den Bereich „Zugangsdaten“ zu öffnen.
    Wenn keine API-Zugangsdaten vorhanden sind, müssen Sie sie generieren.
  4. Klicken Sie auf Generieren.
    Eine Client-ID und ein geheimer Schlüssel werden generiert. Sie können sie in die Zwischenablage kopieren.
    1. Speichern Sie diese Zugangsdaten an einem sicheren Ort und generieren Sie sie gemäß den Sicherheitsrichtlinien Ihrer Organisation regelmäßig neu.
    2. Wenn Sie die vorhandenen API-Zugangsdaten ändern möchten, müssen Sie neue generieren.
  5. Klicken Sie auf Erneut generieren.


  6. Klicken Sie im Fenster Schlüssel erneut generieren auf Erneut generieren.
  7. Es werden eine neue Client-ID und ein neuer Geheimer Schlüssel ausgestellt.
    1. Die Client-ID und der geheime Schlüssel laufen erst ab, wenn Sie ein neues Paar erstellen.
    2. Nachdem Sie Ihre Zugangsdaten generiert haben, verwenden Sie die entsprechende URL basierend auf der Region, in der sich die Geräte Ihrer Organisation befinden.
      1. NAEA: https://auth.naea1.uds.lenovo.com
      2. EU:
        https://auth.euwe1.uds.lenovo.com


Info
Sie müssen über ein Organisationsadministrations-Konto im LDO-Portal verfügen, um 
API-Zugangsdaten generieren zu können.

Bearer-Token abrufen

Das Bearer-Token ist eine Art von Zugriffstoken, das Auth 2.0 mit einem Ablaufzeitraum von 30 Minuten verwendet. Um ein neues Zugriffstoken zu erhalten, muss Ihre Anwendung dieses Bearer-Token zusammen mit Ihrer Client-ID an den Authentifizierungsserver senden. Dieser Überprüfungsprozess stellt sicher, dass nur die autorisierte Anwendung (diejenige, für die das Bearer-Token ursprünglich ausgestellt wurde) neue Zugriffstoken anfordern kann.
  1. Generieren Sie ein API-Bearer-Token mithilfe der externen API.
  2. Die URL – Basis-URL + /api/v1/auth/<Organisationsname>/token
  3. Die Basis-URL hängt von Ihrer Region ab (NA oder EU).
  4. Der Textkörper sollte „x-ww-form-urlencoded“ sein und Folgendes enthalten:
    1. grant_type: client_credentials
    2. client_secret: Geheimnis (von der Seite „API-Zugangsdaten“)
    3. client_id: ID (von der Seite „API-Zugangsdaten“)
Notes
Generieren Sie ein neues Bearer-Token, wenn es nach 30 Minuten abläuft.

 
 

API-Operationen mit Swagger erkunden

Das Archiv mit Swagger-Spezifikationen enthält einen Ordner mit einer Datei namens „index.html“ und einigen anderen JavaScript-Dateien.
  1. Laden Sie die „Swagger Specification“-ZIP-Datei herunter, die Details zu jeder API enthält.
  2. Extrahieren Sie die Dateien im Ordner.
  3. Doppelklicken Sie auf die Datei index.html, um sie zu öffnen. Sie sehen die Startseite der LDO-Geräteinformations-APIs (LDI ist veraltet) in Swagger.
  4. Generieren Sie ein Bearer-Token.

APIs ausprobieren

  1. Wählen Sie in Swagger eine API-Methode aus.
  2. Verwenden Sie das Bearer-Token im Aufruf.
  3. Klicken Sie auf Ausprobieren.
 

Beispiele für API-Methoden

Authentifizierung – API-Token-Sitzung

 
Lenovo SDK-Snapshot



HTTP-Antwort
 

Negatives API-Beispiel: Groovy ACME-Test


HTTP-Anforderung

 
HTTP-Antwort
​