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

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

1. Suchen Sie nach der Schaltfläche Autorisieren in der oberen rechten Ecke der Orchestrator-API-Seite (OrchestratorURL/swagger). Wenn das Schloss geöffnet ist, sind Sie nicht autorisiert.
   
   

   

   
   
2. Klicken Sie auf Autorisieren. Das Fenster Verfügbare Autorisierungen wird angezeigt.
   Hinweis: Derzeit unterstützen wir ein Autorisierungsschema namens 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. Klicken Sie anschließend auf Schließen oder X , um das Fenster Verfügbare Autorisierungen zu schließen. Die Schaltfläche Autorisieren zeigt ein geschlossenes Schloss an, was bedeutet, dass Sie autorisiert sind.

Senden von Anfragen

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.
   
   

   

   
   
2. Klicken Sieim erweiterten Methodenfenster auf Ausprobieren .
3. Geben Sie bei Bedarf Parameterwerte an.
4. Klicken Sie auf Ausführen. Die Anforderung wird ausgeführt. Für Ihre Anforderungen wird automatisch ein Inhaberautorisierungsheader verwendet.
   
   

   

   
   

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 (OrchestratorURL/swagger). Das Symbol sollte ein geschlossenes Schloss anzeigen.
   
   

   

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

   

   
   
3. Schließen Sie das Fenster Verfügbare Autorisierungen , indem Sie auf Schließen oder X klicken, 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 (OrchestratorURL/swagger). Das Symbol sollte ein geschlossenes Schloss anzeigen, was bedeutet, dass Sie autorisiert sind.
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.