Die Swagger-UI-Schnittstelle ermöglicht das Anzeigen und Ausprobieren von API-Operationen. Das Anzeigen der Swagger-UI ist allen Benutzern mit Zugriff auf die UI gestattet, der Zugriff auf die API-Methoden in der Swagger-UI ist jedoch nur Benutzern mit einer Rolle gestattet, die über die Regel AllowAction ManagementApi.Admin imRollenkonfiguration.
ApiAccessManagement, ApiSpecifications und EnvironmentVariablesAPI-Operationen sind sogenannte CRUD-Operationen, bei denen Sie Erstellungs-, Lese-, Aktualisierungs- und Löschvorgänge über die API durchführen können.
Wenn Sie beispielsweise einen API-Regelsatz erstellen, können Sie Beispielwerte für den Nachrichtentext verwenden und die Werte nach Wunsch bearbeiten, bevor Sie einen API-Regelsatz erstellen.
Wenn Sie beispielsweise einen API-Schlüssel mit API-Regelsätzen erstellen, sollten Sie die API-Regelsatz-IDs und die Umgebungs-ID in die Anforderungsnachricht eintragen.
UmgebungenAPI-Operationen dienen zum Abrufen von Umgebungs- und Agentengruppeninformationen wie Umgebungs-IDs/Agentengruppen-IDs. Diese Informationen werden beispielsweise beim Erstellen von API-Schlüsseln und Bereitstellen/Aufheben der Bereitstellung von Prozessen benötigt.
Wenn Sie beispielsweise den API-Aufruf „Alle Umgebungen auflisten“ ausführen, werden Agentengruppen zurückgegeben, die jeweils die Umgebungs-ID und die Agentengruppen-ID enthalten.
Prozesse, Prozessbereitstellungen und ProzessinstanzenAPI-Operationen dienen zum Importieren/Exportieren von Prozessen, zum Auflisten von Prozessen/Prozessinstanzen/Prozessbereitstellungen, zum Bereitstellen/Aufheben der Bereitstellung von Prozessen, zum Aktivieren/Deaktivieren von Triggern und zum Ausführen von Prozessen in der angegebenen Agentengruppe.
Mit dem Prozessimport können Sie einen oder mehrere Prozesse aus JSON importieren und mit dem Prozessexport erhalten Sie JSON. Sie können einen oder mehrere Prozesse exportieren.
Swagger-UI-Ansicht und -Operationen auf der Hauptebene.
Sie können auf der Swagger-Benutzeroberfläche verschiedene Anfragen ausprobieren. Dabei wird für die Autorisierung automatisch das Konto verwendet, mit dem Sie bei Frends angemeldet sind.
Verwandte ArtikelErstellen einer Frends-APIAPI-VerwaltungAuthentifizierung zum Anzeigen der API-SpezifikationenVerwaltungs-APIManagement-API v.0.9 Endpunkte