APIs

Das BPC und die BPC-Module bieten mehrere API-Endpunkte für eine automatisierte Steuerung und Nutzung an. Auf dieser Seite befinden sich die Liste der dokumentieren API-Endpunkte und der Zugang zu der OpenAPI-konformen Dokumentation.

Für den Zugriff auf die BPC-API ist in der Regel ein angemeldeter Benutzer bzw. API-Key notwendig. Die Verwendung eines API-Keys wird empfohlen. Bitte beachten Sie, dass für den Zugriff auf bestimmte Endpunkte jeweils die erforderlichen Rollen bzw. Rechte vorhanden sein müssen.

BPC APIs

Die Basisinstallation des BPCs (Core Services) bietet eine Vielzahl an API Endpunkten an. Diese können im Abschnitt Core Services API angesehen werden.

Darüber hinaus bieten folgende BPC-Module dokumentierte API-Endpunkte an:

Forms API

OpenApi Dokumentation

Neben dieser Dokumentation stellen wir auch OpenAPI-konforme Spezifikationen zur Verfügung. Diese OpenApi-Dokumente finden Sie auf unserer Downloadseite.

Ergänzend zur standardkonformen Beschreibung der Endpunkte enthalten die OpenAPI-Dokumente zusätzliche, BPC-spezifische Erweiterungen. Dazu gehören die benutzerdefinierten Eigenschaften x-bpc-auth-right-or-role-needed, x-bpc-auth-role-needed und x-bpc-auth-right-needed, die auf erforderliche Rollen bzw. Rechte für den Zugriff auf einzelne Endpunkte hinweisen.

Zusätzlich kann das BPC zur Laufzeit OpenApi-Dokumente dynamisch bereitstellen, die automatisch den korrekten Host in der servers-Sektion konfigurieren. Um diese Funktion zu aktivieren, setzen Sie in der Konfigurationsdatei etc/de.virtimo.bpc.core.cfg die Option:

de.virtimo.bpc.core.openapi.enabled = true

Danach sind die OpenApi-Dokumente unter folgenden Pfaden erreichbar:

cxf/bpc-core/openapi.json,
cxf/bpc-httpproxy/openapi.json,
cxf/bpc-logservice/openapi.json,
cxf/bpc-auditlog/openapi.json,
cxf/bpc-deployment/openapi.json und
cxf/bpc-flow/openapi.json.

Die jeweiligen Dokumente stehen zusätzlich auch im YAML-Format zur Verfügung.

Keywords: