Autorisieren von API-Aufrufen in Swagger

Zugreifen auf Swagger

Wenn Sie Ihre API mit Swagger ausprobieren, brauchen Sie sich nur auf einer separaten Registerkarte bei Orchestrator anzumelden.

The Orchestrator API Swagger definition can be accessed by adding the /swagger/ui/index#/ suffix to your Orchestrator URL. For example, https://{yourDomain} /swagger/ui/index#/.

Abrufen eines Zugriffstokens

Führen Sie die folgenden Schritte aus, um API-Aufrufe über die Swagger-UI in Ihrer Orchestrator-Instanz zu autorisieren:

1. Look for the Authorize button at the top right corner of the Orchestrator API page (OrchestratorURL/swagger). If the lock is open, you are unauthorized.

   

2. Klicken Sie auf Autorisieren. Das Fenster Verfügbare Autorisierungen wird angezeigt.

   Hinweis:

   Wir unterstützen derzeit ein Autorisierungsschema mit dem Namen OAuth2.

   

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. Klicken Sie auf Autorisieren. Ein neues Fenster wird angezeigt, in dem bestätigt wird, dass Sie autorisiert wurden.

5. Wenn Sie fertig sind, klicken Sie auf Schließen oder X, um das Fenster Verfügbare Autorisierungen zu schließen. Die Schaltfläche „Autorisieren“ zeigt ein geschlossenes Schloss an, das bedeutet, dass Sie autorisiert sind.

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 1. Unauthorized API resource

   

2. Wählen Sie im erweiterten Methodenfenster die Option Ausprobieren aus.

3. Geben Sie bei Bedarf Parameterwerte an.

4. Wählen Sie Ausführen. Die Anforderung wird ausgeführt.Ein Bearer-Autorisierungsheader wird automatisch für Ihre Anforderungen verwendet.

   Figure 2. 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. Look for the Authorize button at the top right corner of the Orchestrator API page (OrchestratorURL/swagger). The lock should be closed.

   

2. Klicken Sie auf Autorisieren und auf der angezeigten Seite Verfügbare Autorisierungen auf Abmelden , um das abgelaufene Token zu widerrufen.

   

3. Close the Available authorizations window by clicking 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. Look for the Authorize button at the top right corner of the Orchestrator API page (OrchestratorURL/swagger). The lock should be closed, meaning you are authorized.
2. Klicken Sie auf Autorisieren und auf der angezeigten Seite Verfügbare Autorisierungen auf Abmelden.
3. Schließen Sie das Fenster Verfügbare Autorisierungen, indem Sie auf Schließen oder X klicken. Die Schaltfläche Autorisieren zeigt ein offenes Schloss, was bedeutet, dass Sie nicht autorisiert sind.