View Navigation
Transforms   ->

Enrich with an API

Use the Enrich with an API step to make API requests using a list of data, enriching each row with data from an external API endpoint.

Input/output

My input data has two columns: "data.id" and "data.employee_name".

My output data, after using the Enrich with an API step, has three new columns appended to it: "api.status", "api.data.id", "api.data.employee_name". This data was appended to each row that made the call to the API.

Custom settings

First, decide if your data requires a GET or POST operation and select it in the Type dropdown. A GET operation is the most common way to request data from an API. A POST is another way to request data, though it is more commonly used to make changes, such as adding a new user to a table.

Insert your API Endpoint URL in the text field.

Sending a body in your API request

  • A GET cannot send a Body in its request. A POST can send a Body in its request. In Parabola, the Body of the request will always be sent in JSON.
  • Simple JSON looks like this:
{ "key1":"value1", "key2":"value2", "key3":"value3" }

Using merge tags

  • Merge tags can be added to the API Endpoint URL or the Body of a request. For example, if you have a column named "data.id", you could use it in the API Endpoint URL by including {data.id} in it. Your URL would look like this:
http://third-party-api-goes-here.com/users/{data.id}
  • Similarly, you can add merge tags to the body.
{
"key1": "{data.id}",
"key2": "{data.employee_name}",
"key3": "{Type}"
}
  • For this GET example, your API Endpoint URL will require an ID or some sort of unique identifier required by the API to match your data request with the data available. Append that ID column to your API Endpoint URL. In this case, we use {data.id}.

Authentication

Most APIs require some sort of authentication to access their data. This should make sense, as you need to login to view your account and data inside of most apps.

API docs will usually have a section on this. Try searching for the word Authentication in the docs pages.

Parabola's authentication settings are the same across all of our API steps: Pull from an API step, Send to an API step, Enrich with an API step. Head to the API integration doc for more information on authenticating your API steps on Parabola.

Try Parabola for free