Public API

Mit der Public API erstellen Sie REST-Abfragen an GBTEC Process Design, GBTEC Enterprise Architecture und GBTEC Work Orchestrator. So legen Sie zum Beispiel Vorgänge an oder pflegen Diagrammdaten aus einer externen Anwendung heraus.

Wo finde ich die Endpunkte der Public API?

Alle verfügbaren Endpunkte finden Sie in der interaktiven Swagger-UI. Dort sehen Sie auch die genauen Anfrage- und Antwortformate.

Nutzen Sie den folgenden Link zur Swagger-UI. Wählen Sie oben rechts unter Select a definition die passende Definition für Ihr Produkt aus.

Tipp

Sollte der Link zur Swagger-UI nicht funktionieren, geben Sie stattdessen die folgende URL manuell ein: https://{{host}}/public/swagger-ui/index.html. Ersetzen Sie {{host}} durch Ihren Host.

Wie authentifiziere ich mich?

Bei jeder REST-Abfrage an einen Endpunkt der Public API geben Sie zur Authentifizierung einen gültigen API Key im Request Header mit.

Wie Sie Ihren API Key erhalten, hängt vom Produkt ab. Als ProcessApp Administrator erstellen Sie Ihren API Key für GBTEC Work Orchestrator selbst. Öffnen Sie dazu in der linken Menüleiste den Menüeintrag Administration und wählen Sie die Kachel API Key aus. Mehr dazu erfahren Sie im Kapitel Wie kann ich meinen API Key verwalten?.

Für GBTEC Process Design und GBTEC Enterprise Architecture gibt es dafür keine feste Benutzerrolle. Jeder Benutzer erhält den benötigten API Key von seinem Ansprechpartner bei GBTEC.

Zusätzlich zum API Key benötigen Sie für jeden Endpunkt Ihre Tenant-ID. Diese geben Sie als Parameter tenantId an. Darüber ordnet die API Ihre Anfrage automatisch Ihrem Tenant zu. Ihre Tenant-ID finden Sie zum Beispiel in der URL Ihres Browsers.

Konkrete Beispiele für einzelne Endpunkte finden Sie in den produktspezifischen Kapiteln, zum Beispiel Wie kann ich einen neuen Vorgang über die REST API erstellen? für GBTEC Work Orchestrator oder Dashboards API für GBTEC Process Design.

Tipp

Wenn Sie GBTEC Work Orchestrator nutzen, haben Sie eine Alternative zur Public API. Als Benutzer mit der Benutzerrolle ProcessApp Creator können Sie Katalogeinträge auch über dessen Tools annehmen, erstellen, bearbeiten oder löschen. Mehr dazu erfahren Sie im Kapitel MCP Servers.