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 Form Load plugin

1. In Form Builder, navigate to the Settings tab.
2. For Load Data From, select API Connector from the drop-down list.
   

Properties configuration

Load Data From (API Connector): Configure API Connector:

• API Connector: Select the API connector created.
• Do not execute when no record id?: Checking this option displays a blank form when there are no records.
• Select Operation: Select a GET operation created in the API Connector Builder.
  
  
• Base JSON Object Name for Multirow Data: select the name of the base JSON object (e.g., name).
• Primary Key: Select a primary key.
• Manual Field Mapping: If checked, you can manually map fields if the field name and JSON object name do not match.
  • Field Mapping:
    • FIELD NAME
    • JSON OBJECT NAME

• Handling for Field Workflow Variable?: Update workflow variable on form field. Not applicable for grid elements.

• Handling for Uploaded Files?: Store uploaded files to "app_formuploads" based on form properties table name.
  

Related documentation

• Form Data Store