Autorisieren von API-Aufrufen in Swagger

Zugreifen auf Swagger

Um auf den Orchestrator API-Swagger zuzugreifen, hängen Sie /swagger/index.html an die Orchestrator-URL an. Zum Beispiel: https://{yourDomain}/swagger/index.html.

Die API, die Sie in Swagger sehen, ist direkt von der Orchestrator-Instanz abhängig, die Sie verwenden. Um Anfragen direkt in Swagger zu stellen, müssen Sie sich auf einer anderen Registerkarte beim Orchestrator anmelden.

Abrufen eines Zugriffstokens

Um API-Aufrufe über die Swagger-Benutzeroberfläche für Orchestrator-Dienste zu autorisieren, führen Sie die folgenden Schritte aus:

1. Suchen Sie nach der Schaltfläche Autorisieren in der oberen rechten Ecke der Orchestrator API-Seite. Wenn das Schloss offen ist, haben Sie keine Berechtigung.

   Figure 1. Authorize button
   

   

   
   

2. Select Authorize. The Available authorizations window is displayed.

   Hinweis: Derzeit unterstützen wir ein Autorisierungsschema namens OAuth2.
   Figure 2. Available authorizations
   

   

   
   
3. Alle Scopes sind vorausgewählt, sodass Sie mit allen Endpunkten in der Orchestrator-API experimentieren können. Deaktivieren Sie sie, wenn Sie den Zugriff auf bestimmte APIs einschränken möchten.
4. Select Authorize. A new window is displayed confirming you have been authorized.
5. Once done, select Close or X to close the Available authorizations window. The Authorize button shows an closed lock meaning you are authorized.

Senden von Anforderungen

Während Sie autorisiert sind, können Sie wie folgt Anforderungen an Orchestrator-API-Ressourcen stellen:

1. Erweitern Sie eine Orchestrator-API-Ressource, mit der Sie einen Vorgang ausführen möchten. Das geschlossene Schloss bedeutet, dass Sie autorisiert sind.
   Figure 3. Unauthorized API resource
   

   

   
   
2. In the expanded method window, select Try it out.
3. Geben Sie bei Bedarf Parameterwerte an.
4. Select Execute. The request is executed. A bearer authorization header is automatically used for your requests.
   Figure 4. Bearer authorization header
   

   

   
   

Generieren eines neuen Zugriffstokens

Wenn das Zugriffstoken abläuft, erhalten Sie eine 401: You are not authenticated! -Antwort. Der Inhaberautorisierungsheader ist immer noch für Ihre Anforderungen vorhanden, aber das Zugriffstoken ist abgelaufen. In diesem Fall müssen Sie das abgelaufene Token für ungültig erklären und ein neues Zugriffstoken generieren:

1. Suchen Sie nach der Schaltfläche Autorisieren in der oberen rechten Ecke der Orchestrator API-Seite. Das Schloss sollte geschlossen werden.
   Figure 5. Authorize button
   

   

   
   
2. Select Authorize and on the displayed Available authorizations page, select Logout to revoke the expired token.
   Figure 6. Available authorizations
   

   

   
   
3. Close the Available authorizations window by selecting Close or X and then obtain an access token as described on the Obtaining an access token section.

Widerrufen von Zugriff

Wenn Sie mit der Arbeit mit der Swagger-UI fertig sind, sollten Sie das von Ihnen verwendete Zugriffstoken für ungültig erklären:

1. Suchen Sie nach der Schaltfläche Autorisieren in der oberen rechten Ecke der Orchestrator API-Seite. Das Schloss sollte geschlossen sein, d. h. Sie sind authorisiert.
2. Klicken Sie auf Autorisieren , und klicken Sie auf der angezeigten Seite Verfügbare Autorisierungen auf Abmelden.
3. Schließen Sie das Fenster Verfügbare Autorisierungen , indem Sie auf Schließen oder Xklicken. Die Schaltfläche Autorisieren zeigt ein offenes Schloss an, was bedeutet, dass Sie nicht autorisiert sind.