APIs

The BPC and the BPC modules offer several API endpoints for automated control and use. This page contains the documented API endpoints List of documented API endpoints and the Access to the OpenAPI-compliant documentation.

Access to the BPC API generally requires a registered user or API key is usually required to access the BPC API. The use of an API key is recommended. Please note that the required roles or rights must be available to access certain endpoints.

BPC APIs

The basic installation of the BPC (Core Services) offers a variety of API endpoints. These can be viewed in the section Core Services APIs.

In addition, the following BPC modules offer documented API endpoints:

Forms API

OpenApi documentation

In addition to this documentation, we also provide OpenAPI-compliant specifications. These OpenApi documents can be found on our Download page.

In addition to the standard-compliant description of the endpoints, the OpenAPI documents contain additional, BPC-specific extensions. These include the user-defined properties x-bpc-auth-right-or-role-needed, x-bpc-auth-role-needed and x-bpc-auth-right-needed, which indicate the roles or rights required for access to individual endpoints.

In addition, the BPC can dynamically provide OpenApi documents at runtime, which automatically configure the correct host in the servers section. To activate this function, set the option in the configuration file etc/de.virtimo.bpc.core.cfg:

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

The OpenApi documents are then accessible under 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 YAML format.

Keywords: