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

Compare with Current View Page History

Version 1 Next »

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

  1. In Process Builder, click the Tool component in the participant track.
  2. In the Mapping tab, select API Connector in the Tools drop-down list.
  3. Under Configure API Connector, for API Connector, select the API connector created.
  4. Under API Connector, for Select Operation, select the operation created in the API Connector Builder.
  5. Depending on the HTTP method of the operation, configure:
    • id
    • Payload
  6. Under Store To Form, for Form, select a form to store the data to.
  7. For Base JSON Object Name for Multirow Data, select the name of the base JSON object (e.g., data).
  8. For Field Mapping, configure:
    • FIELD NAME
    • JSON OBJECT NAME
  9. Under Store To Workflow Variable, for 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
  10. Click Apply Change.

Related documentation

  • No labels