Beschreibung der Management-API Version 0.9.
Geschrieben vonOssi Galkin Vor über einer Woche aktualisiertTable of contentsVerwaltungs-API v.0.9
In Frends Version 5.6 befindet sich die Management-API in der Betaphase, da wir Daten zu ihrer Nutzung sammeln möchten. Wir werden versuchen, sie in Frends 5.7 offiziell zu veröffentlichen. Der aktuelle Stand der Management-API wird der endgültige sein.
Mit der Management-API können Sie Frends steuern, ohne das Control Panel zu verwenden. So können Sie Frends beispielsweise mit der CI/CD-Pipeline verbinden oder Protokolle an anderer Stelle analysieren. Derzeit ist nicht alles, was im Control Panel möglich ist, in der Management-API möglich, aber unser Ziel ist es, dorthin zu gelangen.
Sie finden die Swagger-Benutzeroberfläche der Management-API unter der URLhttps://TENANTNAME.frendsapp.com/swagger/ui/
Oder reine JSON-Spezifikation unter URLhttps://TENANTNAME.frendsapp.com/v0.9/swaggerGrober Überblick über die Management-API ist
API-Zugriffsverwaltung
Mit ApiAccessManagement können Sie API-Schlüssel und API-Regelsätze abrufen, löschen, erstellen oder ändern.
API-Spezifikationen
Mit ApiSpecifications-Endpunkten können Sie Open Api Specifications erstellen, ändern, löschen, veröffentlichen (d. h. speichern) und bereitstellen, Prozessvorlagen verknüpfter Prozesse abrufen und verknüpfte Prozesse bereitstellen.
Umgebungen
Mit Umgebungsendpunkten können Sie Umgebungen und Agentengruppen abrufen und auflisten.
Umgebungsvariablen
Mit EnvironmentVariables-Endpunkten können Sie Umgebungsvariablen erstellen, ändern und löschen.
Prozessbereitstellungen
Mit ProcessDeployments-Endpunkten können Sie Prozessbereitstellungen abrufen, auflisten und durchführen sowie Trigger aktivieren und deaktivieren.
Prozesse
Prozessendpunkte werden zum Auflisten, Importieren, Exportieren und Löschen von Prozessen verwendet. Wenn Sie Prozesse in bestimmten Agentgruppen abrufen möchten, sollten Sie ProcessDeployments-Endpunkte verwenden.
Prozessinstanzen
Der Endpunkt ProcessInstances wird verwendet, um Prozessinstanzen (d. h. Protokolldaten) abzurufen. Es werden nur die Daten auf Prozessebene zurückgegeben, Schrittdaten (d. h. Taskergebnisse) werden also nicht zurückgegeben.
Verwandte ArtikelErstellen einer Frends-APIAPI-VerwaltungVerwaltungs-APIEinführung in die Bereitstellung von APIs und die API-VersionskontrolleÄnderungen an Frends API 1.0