SD-WAN Orchestrator-API-Handbuch

Um auf das SD-WAN Orchestrator-API-Handbuch auf der Swagger-Benutzeroberfläche zuzugreifen, müssen Sie sich mit einem API-Schlüssel authentifizieren. Das folgende Verfahren enthält Anweisungen zum Generieren eines API-Schlüssels und deren Verwendung für die Authentifizierung.

  1. Melden Sie sich bei Ihrem Citrix Cloud-Konto an und navigieren Sie zu Identitäts- und Zugriffsverwaltung > API-Zugriff.

    Hinweis:

    Wenn Sie ein Partner sind, der APIs im Auftrag Ihres Kunden ausführt, melden Sie sich mit der Option Kunde ändern beim Citrix Cloud-Konto des Kunden an, oder rufen Sie die Authentifizierung und die entsprechenden API-Parameter vom Kunden ab.

    Identitäts- und Zugriffsverwaltung

    Erstellen eines sicheren Clients

  2. Geben Sie einen Namen für Ihren sicheren Client ein, und klicken Sie auf Client erstellen. Eine ID und ein geheimer Schlüssel werden generiert. Verwenden Sie die ID und den geheimen Schlüssel, um sich zu authentifizieren, wenn Sie APIs zum Verwalten Ihres Netzwerks verwenden.

    Hinweis:

    Laden Sie die ID und das Geheimnis herunter und speichern Sie sie sicher. Sie können nach dem Schließen des Fensters nicht auf geheime Daten zugreifen.

    ID und Geheimhaltung

    Hinweis:

    Aus Sicherheitsgründen wird empfohlen, die API-Schlüsseleinträge aus Citrix Cloud zu löschen, wenn Sie mit den APIs fertig sind.

    ID und Geheimhaltung

  3. Melden Sie sich bei SD-WAN Orchestrator an und klicken Sie oben rechts auf der Benutzeroberfläche auf das API-Symbol.

    API-Symbol

    Die Swagger-Spezifikationsdetails werden angezeigt.

    API-Symbol

  4. Klicken Sie auf die Swagger-Spezifikations-URL, um auf das API-Handbuch zuzugreifen.

  5. Navigieren Sie auf der API-Seite zu auth-controller > /{ccId}/api/v1/logon > Probieren Sie es aus.

    Auth controller

  6. Kopieren Sie die Citrix Cloud-IDaus den SD-WAN Orchestrator Swagger-Spezifikationsdetails und fügen Sie sie in das Textfeld unter der Citrix Cloud-Benutzer-IDein.

  7. Kopieren und fügen Sie die Client-ID, den geheimen Client und die Citrix Cloud ID in die entsprechenden Payload-Felder ein, und klicken Sie auf Ausführen.

    API-Nutzlast

  8. Kopieren Sie den Tokenwert aus der Serverantwort.

    Antwort des Servers

  9. Klicken Sie oben auf der API-Seite auf Autorisieren, und fügen Sie den Tokenwert in das Feld Wert ein. Klicken Sie auf Authorize.

    Autorisieren

    API-Schlüssel

Damit ist der Autorisierungsprozess abgeschlossen, und Sie sollten nun auf SD-WAN Orchestrator-APIs zugreifen und diese verwenden können.

SD-WAN Orchestrator-API-Handbuch