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
Uses the API Connector as a data source to retrieve the API data.
- In List Builder, in the DATA tab, for Select Source of Data, select API Connector from the drop-down list.
- For API Connector, select the API Connector created.
- For Select Operation, select the operation created in API Connector Builder. Depending on the operation type, configure:
- id
- Payload
- For Base JSON Object Name for Multirow Data, configure the name of the base JSON object (e.g., data).
- For Total Record Count JSON Object Name, configure the total number of records in the JSON object (e.g., data.total).
- For Primary Key, configure the Unique Identifier of the JSON object (e.g., data.id). Mandatory field.
- Optionally, check the Auto Handling Full Results Paging & Sorting option if you retrieve all the records. The paging and sizing will be handled by Joget DX.