BPS REST API

Getting Started

BPS REST API is available by the following URL:

<BPS Portal URL>/api/data

Where BPS Portal URL is the base URL of the BPS Portal in your network environment. For example, you have your company’s server www.mycompany.com, and BPS Portal configured to be accessible by www.mycompany.com/webconbps.

/api/data is the context path for the BPS REST API.

For the sample base URL above, REST API URL is:

https://www.mycomapny.com/webconbps/api/data

BPS REST API is available in all types of installations since BPS 2019, and enables external systems to perform operations on workflow instances and their attachments.

BPS REST API is RESTFull Web service, hosted in BPS Portal. It uses JSON Web Token (JWT) authentication method. The Web service can be employed by any technology that can use HTTP requests.

Calling service

To call WEBCON BPS REST API, your application must acquire an access token, which contains information about your application and the permissions it has. To call any method, you attach the access token as a Bearer token to the authorization header in an HTTP request, and send that request to selected endpoint.

Example available operations:

• Creating new instances in the WEBCON BPS system
• Editing an existing instance
• Moving an instance to the next step
• Adding new attachments
• Retrieving an instance’s attachments

Resources

• In the Authentication section you can learn more about process of authentication.
• In the Using API section you can learn more about Management as well as Data operations available via API.