REST-API

Die Programmierschnittstelle, Aeneis REST-API, wird im Format OpenAPI 3.0.0 zur Verfügung gestellt. Die Dokumentation der Aeneis REST-API können Sie als YAML-Datei herunterladen und über den Swagger-Editor direkt im Browser öffnen.

Voraussetzung: Um die REST-API zu verwenden, muss Ihr Benutzer der Benutzergruppe REST-API zugewiesen sein.

Hinweis: Gruppenmitglieder können nur durch einen Administrator zugewiesen werden.

Anleitung:

  1. Wählen Sie in der SystemAdministration in der Menüleiste Hilfe | API-Dokumentation aus, um die REST-API als YAML-Datei herunterzuladen:

  1. Öffnen Sie einen neuen Browser-Tab

  2. Öffnen Sie den Swagger-Editor mit folgendem Link: https://editor.swagger.io/

  3. Wählen Sie im Swagger-Editor in der Menüleiste File | Import file aus:


Upload-API erlauben

Wenn Sie den API-Endpunkt POST/GET {baseUrl}/upload/file nutzen möchten, aktivieren Sie beim entsprechenden Aeneis-Benutzer die Option Upload-API erlauben.

Voraussetzung: Sie haben Administratorrechte, um die Option zu aktivieren.