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.Process Tool plugin allows you to
Get started
API Connector Process Tool plugin
- 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.
Properties configuration
...
- 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:
- id
- Payload
...
- Form: Select a form to store the data to.
...
- Base JSON Object Name for Multirow Data
...
- : Select the name of the base JSON object (e.g., data).
...
- Field Mapping
...
- : Allows for manual mapping of a field name to a JSON object name if the names are different.
- FIELD NAME
- JSON OBJECT NAME
...
- Workflow Variable
...
- Mapping, click Add and configure the following:
- Workflow Variable
- Status (Create Account)
- status (basicinfo Approval Process, basicinfo Approval Approval Process)
- JSON Object Name
- Workflow Variable
...