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

To call where to perform role?(video 1 minute 4:15) or list actions

1. In the Design tab, under the Actions palette, drag and drop the API Connector to the list or canvas.
   
   
2. Click the API Connector to configure the properties.
3. Click Apply Change and click SAVE.

Properties configuration

• API Connector: Select the created API connector.
• Select Operation: Select an operation created in the API Connector Builder. Depending on the operation selected, configure:
  • id: Available with the GET and DELETE methods. Specify the ID of the item to fetch or delete.
  • Payload: Available with the POST and PUT methods. The structure of the API in JSON or YAML format. You can add many more details, like authentication methods, request parameters, query parameters, or more complex schemas.

• Confirmation Message: Displays a message when the operation is completed.

Related documentation

• Datalist Action Plugin