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.

   Abbildung 1. Schaltfläche Autorisieren

2. Wählen Sie Autorisieren. Das Fenster Verfügbare Autorisierungen wird angezeigt.

   Hinweis:

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

   Abbildung 2. Verfügbare Autorisierungen

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. Wählen Sie Autorisieren. Ein neues Fenster wird angezeigt, das bestätigt, dass Sie autorisiert wurden.

5. Wählen Sie anschließend Schließen oder X aus, um das Fenster Verfügbare Autorisierungen zu schließen. Die Schaltfläche Autorisieren zeigt ein geschlossenes Schlosssymbol an, was 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.

   Abbildung 3. Nicht autorisierte API-Ressource

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.

   Abbildung 4. Bearer-Autorisierungsheader

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.

   Abbildung 5. Schaltfläche Autorisieren

2. Wählen Sie Autorisieren aus und auf der angezeigten Seite Verfügbare Autorisierungen die Option Abmelden um das abgelaufene Token zu widerrufen.

   Abbildung 6. Verfügbare Autorisierungen

3. Schließen Sie das Fenster Verfügbare Autorisierungen, indem Sie Schließen oder X auswählen, und rufen Sie dann ein Zugriffstoken ab, wie im Abschnitt „Abrufen eines Zugriffstokens“ beschrieben.

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 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.