APIs
The BPC and BPC modules offer several API endpoints for automated control and use. This page contains a list of documented API endpoints and access to OpenAPI-compliant documentation.
Access to the BPC API generally requires a logged-in user or an API key. Using an API key is recommended. Please note that the necessary roles or permissions must be in place to access specific endpoints.
BPC APIs
The basic installation of BPC (Core Services) offers a wide range of API endpoints. These can be viewed in the section Core Services API.
In addition, the following BPC modules offer documented API endpoints:
OpenAPI Documentation
In addition to this documentation, we also provide OpenAPI-compliant specifications. You can find these OpenAPI documents on our download page.
In addition to the standards-compliant description of the endpoints, the OpenAPI documents contain additional, BPC-specific extensions.
These include the custom properties x-bpc-auth-right-or-role-needed, x-bpc-auth-role-needed, and x-bpc-auth-right-needed, which indicate the required roles or permissions for accessing individual endpoints.
Additionally, the BPC can dynamically provide OpenAPI documents at runtime that automatically configure the correct host in the ` servers` section.
To enable this feature, set the following option in the configuration file etc/de.virtimo.bpc.core.cfg:
de.virtimo.bpc.core.openapi.enabled = trueAfterward, the OpenAPI documents are accessible at the following paths:
-
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, and -
cxf/bpc-flow/openapi.json.
The respective documents are also available in the YAML format.
