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 pluginsForm Load plugin allows loading from an API using the GET method.
Get started
API Connector Form Load plugin
- In Form Builder, navigate to the Settings tab.
- ForLoad Data From, select API Connector from the drop-down list.
Properties configuration
Load Data From (API Connector): Configure API Connector:
| Name | Description |
|---|---|
| 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. |
| Name |
|---|
...
| Description |
|---|
| Base JSON Object Name for Multirow Data |
...
| |
| Primary Key |
...
| Select a primary key. | |
| Manual Field Mapping |
...
| |
| 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. |
...