This Release we are adding new API Source options to the Data Connectors framework. We support two API Sources: Push to API and Pull from API.
Pull from API
This source allows you to pull data from any API and use the Connector to convert that data into entities without having to build and host an integration outside of Yext. This method can be used to pull any relevant data from a system you can pull data from via an API. For example, to pull data from a public domain at a regular cadence.
Step 1: Select the Source
To create a Pull Data Connector you will select Pull from API as your Connector Source and select the entity type you would like to create using this connector.
Step 2: Specify API Settings
Then, you will specify the details of the API. The values you enter and the options you select for each setting will depend on the API you are pulling from.
Before getting started here, we recommend looking at the API documentation for the relevant API, and creating a test call so you can easily pull in the relevant information.
The API details include:
- Request URL
- Authentication Method
- Query Parameters
- Headers
- Pagination Control
- Max Requests per Minute
- JSON Type
Push to API
This option allows you to push data to an endpoint either via a regular API call or a Webhook message. With the “Push to API” source, you can create a Connector that will process data pushed to our Connectors API endpoint and turn it into entities in your Knowledge Graph.
Step 1: Select your Source
To create a Pull Data Connector you will select Push to API as your Connector Source and select the entity type you would like to create using this connector.
Step 2: Generate API Endpoint URL
When you choose to push data via API, we will generate a unique URL for you to hit. This URL will consist of the base URL and your API Key. Link the following:
https://api.yext.com/v2/accounts/[accountId]/connectors?v=[vparam]&api_key=[API key]
The rest of the process of configuring your Connector is the same for both Push and Pull API Sources.
Specify Selectors
Once you configure the details for your API request, you will need to Specify Selectors — this is where you decide which data you would like to extract, or “select” from the response. To do this, you will specify the JMES Path expression to identify specific parts of the JSON response you want to pull in.
As you add these, you will be able to see a preview of this data table as you go along.
Add Transforms
At this point your data will appear in a table format in the Yext platform. But before you load it in, we allow you to perform a series of transforms to ensure the data you’re pulling into the Knowledge Graph fits into the correct format and meets the formatting requirements and specifications. You can learn more about transforms in the Data Connectors: Transforms Community Post.
Map Fields & Run
Now you must map the data to fields in Yext to determine which pieces of data feed into specific fields into the Knowledge Graph.
To learn more about building an API Connector, visit our API Connector guides.
We are also going to be adding more Data Connectors over time, and if there is a Data Connector that you’d like to see added — let us know in the comments below!