API Template

What is an API template

The API template is a special category of resources that are built on top of our API Connector. It connects with your external data sources through their official API endpoints.

How to connect a built-in table

An API template resource configuration interface usually contains two sections, a form for default parameters and an "Advanced Settings" option for further customizations.

Let's take Pipedrive as an example.

Assume that I need to retrieve the list of files from Pipedrive to Acho, it requires the following steps:

(1) Open the "Table" dropdown and select "Files".

(2) Fill in the correct "API Token" and "Company Domain".

(3) Click "Test" to preview the result and click "Connect" to save it as a resource.

How to connect a custom table

However, the target table might be listed in the "Table" dropdown. In this case, we can open the "Advanced Settings" section and modify the API Connector configuration directly.

Assume that I need to retrieve the list of pipelines from Pipedrive to Acho, it requires the following steps.

(1) Find the correct API configuration in Pipedrive's official document.

(2) Update the configuration in the "Advanced Settings".

(3) Click "Test" to preview the result and click "Connect" to save it as a resource.

To learn more about the API Connector and its configuration, please check out its dedicated document here.

Last updated