Table of Contents
Introduction
The API Connector Builder allows the app designer to use a third-party API service based on an OpenAPI Specification OAS document to make the integration easier by configuration through UI. In the builder, an app designer can just upload an OAS document and pick the API endpoints they want to use in app design/integration. Then, the created API connector can be used with the following API connector plugins.
Get started
API Connector Process Tool plugin
Process Tool plugin allows you to integrate external APIs into a process.
Get started
- In Process Builder, click the Tool component in the participant track.
- In the Mapping tab, select API Connector in the Tools For Tools, select API Connector from the drop-down list.
- Under Configure API Connector, for API Connector, select the API connector properties and click Apply Change.
Properties configuration
Here's the information in a nested table format to enhance clarity:
| Feature | Details |
|---|---|
| API Connector | Select the API connector created. |
...
| Select Operation |
...
Select the operation created in the API Connector Builder. |
...
Depending on the HTTP method of the operation, configure:
|
...
| ||
| Form | Select a form to store the data to. |
...
| Base JSON Object Name |
...
| Select |
...
| the name of the base JSON object (e.g., |
...
| name). |
...
| Field Mapping | Allows for manual mapping of a field name to a JSON object name if the names are different
|
...
| Workflow Variable Mapping |
...
Click Add |
...
to configure the following:
|
...
|
...