Connect to API

Important Nexla Help Center Update:

Nexla's Zendesk Help Center pages are being deprecated and will soon no longer be available.

Nexla Documentation is now the home for Nexla's User Guides, with improved formatting and categories that are easier to navigate, providing a better overall user experience.

Please update any bookmarks to the new Nexla Documentation site (docs.nexla.com/user-guides).

_______________________________________________

After you've gone through the first steps of connecting a data source, follow these instructions to connect to an API.

1. Click REST API, then click next.

2. Select Add a new Credential and enter a credential name. From there, enter the API Test URL to check authentication. If you don’t have the test URL to connect, please contact your IT, devops, or data engineering team. Then click SAVE.

3. [Optional] In the advanced settings menu, enter the necessary information for Headers. Then click SAVE.

4. You will be redirected to the API Setup screen. Fill out the necessary information and then click TEST to view api response. Then click CREATE.

5.[Optional] Click on Apply Iteration checkbox to iterate over the api. Select the type of iteration supported by the api and fill in the required details.

6.[Optional] To pass data from a lookup as url parameter, select the required lookup from LOOKUPS TO USE IN API URL MACROS dropdown. Then insert a ‘{‘ after the url in the API URL field. Select the required lookup field from the available macros displayed. Click TEST to view api response. Then click CREATE.

7. [Optional] To use data from an api response to call another api, you can click on ADD STEP as shown in the above screenshot. Fill in the required details. Then insert a ‘{‘ after the url in the API URL field. Select the required Step1 response field from the available macros displayed. Click TEST to view api response. You may click on ADD STEP to further create the chain of steps or click CREATE.

8. After creating, you will receive a confirmation page indicating successful creation of the data source.

Here, you can change the name of your data source by hovering over the name and editing. Add a description by hovering over the grey description text. Nexla will automatically save the changes.

Click done to return to My Data Sources. You can also click the View Data Source button to view the source you created directly. Or click the view detected datasets button to view the datasets detected from your source. 

Click done when you are finished and ready to exit.