Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

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.

To see the current Workbench OpenAPI definition, go to [swagger]. The Swagger UI app is embedded into Web Workbench and shows a complete list of all endpoints and supported operations, as well as providing an interactive client to test them in the browser in real time. This is usually a good place to start getting familiar with the Workbench API.

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'.

If you find there is some functionality missing from the Workbench API that is necessary for your integration, feel free to contact us at [enquire] to discuss.

List Endpoints

These endpoints end with the suffix ‘List’, and they return a paged list of resources. They only support the POST HTTP method because a JSON predicate object must be provided in the body of the request, which filters and sorts the returned data. Usually no query parameters are required.

Predicate

If you… you can use a network proxy like Fiddler to help you…

Response

Detail Endpoints

These endpoints end with the suffix ‘Detail’. The expose the CRUD operations of a resource and so usually support the GET, POST, and DELETE HTTP methods. These operations are symmetric, meaning that they share the same JSON data structure. So that the response from a GET request can be modified and used as the body of a POST request to update the resource.

User

API Operations will usually be performed as the authenticating user (the Workbench account that was used in authentication).

For example…

However, some endpoints…

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:

  1. Download Postman

  2. Go to the Workbench Integration Github repository and click the 'Run in Postman' button to import the Workbench Collection and Environment.

  3. Set the 'baseUrl' environment variable to your Web Workbench instance (XXX.wbi.cloud).

  4. Create an Application Client in your Web Workbench instance and generate a bearer token.

  5. Set the 'token' environment variable to the bearer token.

You can now start making API calls using Postman.

  • No labels