Technical
The Workbench API is a REST API, using the standard JSON data format over the HTTP protocol. You use JSON objects and HTTP methods like GET, POST, PUT, and DELETE to interact with resources in Workbench. The API is published to the OpenAPI specification, so there is a formal definition of the complete API as a JSON object which can be used by various tools to generate client code.
...
Releases of the Workbench API come bundled with releases of Web Workbench, so the share the same version numbers and release schedule.
Structure
The Workbench API covers most of the functionality available in Web Workbench. An API endpoint will usually correspond to a specific screen in Web Workbench and share the same business logic. Generally speaking there are 2 different types of endpoints: 'List' and 'Detail'.
...
| Note |
|---|
If you find and endpoint unexpected behaviour it could be related to…, so check the setup of … |
Postman
Postman is an application that lets you test and explore web APIs without having to write code. To get up and running with the Workbench API follow these steps:
Download Postman
Go to the Workbench Integration Github repository and click the 'Run in Postman' button to import the Workbench Collection and Environment.
Set the 'baseUrl' environment variable to your Web Workbench instance (XXX.wbi.cloud).
Create an Application Client in Web Workbench and generate a bearer token.
Set the 'token' environment variable to the bearer token.
You can now start making API calls using Postman.