Building a Custom API Connector for Azure Data Factory (Pipeline)

Read / write Custom API data in Azure Data Factory (Pipeline) without coding.

In this article you will learn how to quickly and efficiently integrate Custom API data in Azure Data Factory (Pipeline) without coding. We will use high-performance Custom API Connector to easily connect to Custom API and then access the data inside Azure Data Factory (Pipeline).

Let's follow the steps below to see how we can accomplish that!

Download Documentation

Create Custom API Connector

First of all, you will have to create your own API connector. For demonstration purposes, in this section we will create a simple Hello-World API connector that calls ZappySys Sandbox World API endpoint https://sandbox.zappysys.com/api/world/hello. When developing your Custom API Connector, just replace it with your real API method/endpoint. Let's dive in and follow these steps:

  1. Open ODBC Data Sources (x64):

    Open ODBC Data Source

  2. Create a User data source (User DSN) based on ZappySys JSON Driver:

    ZappySys JSON Driver
    Create new User DSN for ZappySys JSON Driver

  3. Once the data source configuration window opens, enter this URL into the text box:

    https://sandbox.zappysys.com/api/world/hello

  4. Then go to the Preview tab and try to say "Hello!" to the World!

  5. Since the test is successful, you are ready to create the Hello-World Connector:

  6. The API Connector File Wizard opens, click Next:

  7. Leave the default option, and click Next again:

  8. Just click Next in the next window:

  9. Let's give our new custom connector a name it deserves:

  10. Then just click Next in the Connection Types window:

  11. Let's name the hello endpoint (it deserves a name too!):

  12. When the next window opens, delete the default table (we won't need it for now):

  13. Finally, specify a path, where you want to save the newly created API Connector:

Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from Custom API using Azure Data Factory (Pipeline) we first need to create a DSN (Data Source) which will access data from Custom API. We will later be able to read data using Azure Data Factory (Pipeline). Perform these steps:

  1. Download and install ODBC PowerPack.

  2. Open ODBC Data Sources (x64):

    Open ODBC Data Source

  3. Create a User data source (User DSN) based on ZappySys API Driver:

    ZappySys API Driver
    Create new User DSN for ZappySys API Driver

  4. When the Configuration window appears give your data source a name if you haven't done that already. Then set the path to your created Custom API Connector (in the example below, we use Hello-World Connector). Finally, click Continue >> to proceed:

    Create ODBC data source based on API Driver

  5. Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). Check your Custom API reference for more information on how to authenticate.

    Authenticating to your Custom API in ODBC application

  6. Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:

    ZappySys API Driver - Custom API
    Read / write Custom API data in Azure Data Factory (Pipeline) without coding.
    CustomApiDSN
    Open Query Builder in API ODBC Driver to read and write data to REST API

  7. Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in Azure Data Factory (Pipeline) to retrieve data from Custom API. Hit OK button to use this query in the next step. 

    SELECT * FROM Orders
    Configure table/endpoint parameters in ODBC data source based on API Driver
    Some parameters configured in this window will be passed to the Custom API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful data much faster.

  8. Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in Azure Data Factory (Pipeline):

    ZappySys API Driver - Custom API
    Read / write Custom API data in Azure Data Factory (Pipeline) without coding.
    CustomApiDSN
    SELECT * FROM Orders
    API ODBC Driver-based data source data preview
    You can also access data quickly from the tables dropdown by selecting <Select table>.
    A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Custom API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Custom API servers).

  9. Click OK to finish creating the data source.

Video Tutorial

Read data in Azure Data Factory (ADF) from ODBC datasource (Custom API)

  1. Sign in to Azure Portal

    • Open your browser and go to: https://portal.azure.com

    • Enter your Azure credentials and complete MFA if required.

    • After login, go to Data factories.

    Azure Portal

  2. Under Azure Data Factory Resource - Create or select the Data Factory you want to work with.

    Select the Data Factory

  3. Inside the Data Factory resource page, click Launch studio.

    Launch Azure Data Factory Studio

  4. Create a New Integration Runtime (Self-Hosted):

    • In Azure Data Factory Studio, go to the Manage section (left menu).

    • Under Connections, select Integration runtimes.

    • Click + New to create a new integration runtime.

    Create new Self-Hosted integration runtime

  5. Select Azure, Self-Hosted option:

    Create new Self-Hosted integration runtime

  6. Select Self-Hosted option:

    Create new Self-Hosted integration runtime

  7. Set a name, we will use OnPremisesRuntime:

    Set a name for IR

  8. Download and install Microsoft Integration Runtime.

    Download and install Microsoft Integration Runtime

  9. Launch Integration Runtime and copy/paste Authentication Key from Integration Runtime configuration in Azure Portal:

    Copy/paste Authentication Key

  10. After finishing registering the Integration Runtime node, you should see a similar view:

    Check Integration Runtime node status

  11. Go back to Azure Portal and finish adding new Integration Runtime. You should see it was successfully added:

    Integration Runtime status

  12. Create a New Linked service:

    • In the Manage section (left menu).

    • Under Connections, select Linked services.

    • Click + New to create a new Linked service based on ODBC.

    Add new Linked service

  13. Select ODBC service:

    Add new ODBC service

  14. Configure new ODBC service. Use the same DSN name we used in the previous step and copy it to Connection string box:

    CustomApiDSN
    DSN=CustomApiDSN
    Configure new ODBC service

  15. For created ODBC service create ODBC-based dataset:

    Add new ODBC dataset

  16. Go to your pipeline and add Copy data connector into the flow. In Source section use OdbcDataset we created as a source dataset:

    Set source in Copy data

  17. Then go to Sink section and select a destination/sink dataset. In this example we use precreated AzureBlobStorageDataset which saves data into an Azure Blob:

    Set sink in Copy data

  18. Finally, run the pipeline and see data being transferred from OdbcDataset to your destination dataset:

    Run the flow

Executing SQL queries using Lookup activity

If you need to execute commands in Custom API instead of retrieving data, use the Lookup activity for that purpose. Use this approach when you want data to be changed on the Custom API side, but you don't need the data on your side (a "fire-and-forget" scenario).

Perform these simple steps to accomplish that:

  1. Go to your pipeline in Azure Data Factory

  2. Find Lookup activity in the Activities pane

  3. Then drag-and-drop the Lookup activity onto your pipeline canvas

  4. Click Settings tab

  5. Select OdbcDataset in the Source dataset field

  6. Finally, enter your SQL query in the Query text box:

SELECT * FROM Orders
Configuring Lookup activity in ADF pipeline to perform a command in Custom API

Centralized data access via Data Gateway

In some situations, you may need to provide Custom API data access to multiple users or services. Configuring the data source on a Data Gateway creates a single, centralized connection point for this purpose.

This configuration provides two primary advantages:

  • Centralized data access
    The data source is configured once on the gateway, eliminating the need to set it up individually on each user's machine or application. This significantly simplifies the management process.
  • Centralized access control
    Since all connections route through the gateway, access can be governed or revoked from a single location for all users.
Data Gateway
Local ODBC
data source
Simple configuration
Installation Single machine Per machine
Connectivity Local and remote Local only
Connections limit Limited by License Unlimited
Central data access
Central access control
More flexible cost

If you need any of these requirements, you will have to create a data source in Data Gateway to connect to Custom API, and to create an ODBC data source to connect to Data Gateway in Azure Data Factory (Pipeline).

Let's not wait and get going!

Creating Custom API data source in Gateway

In this section we will create a data source for Custom API in Data Gateway. Let's follow these steps to accomplish that:

  1. Search for gateway in Windows Start Menu and open ZappySys Data Gateway Configuration:

    Opening Data Gateway

  2. Go to Users tab and follow these steps to add a Data Gateway user:

    • Click Add button
    • In Login field enter username, e.g., john
    • Then enter a Password
    • Check Is Administrator checkbox
    • Click OK to save
    Data Gateway - Adding User

  3. Now we are ready to add a data source:

    • Click Add button
    • Give Datasource a name (have it handy for later)
    • Then select Native - ZappySys API Driver
    • Finally, click OK
    CustomApiDSN
    ZappySys API Driver
    Data Gateway - Adding data source

  4. When the ZappySys API Driver configuration window opens, configure the Data Source the same way you configured it in ODBC Data Sources (64-bit), in the beginning of this article.

  5. Very important step. Now, after creating or modifying the data source make sure you:

    • Click the Save button to persist your changes.
    • Hit Yes, once asked if you want to restart the Data Gateway service.

    This will ensure all changes are properly applied:

    ZappySys Data Gateway - Save Changes
    Skipping this step may result in the new settings not taking effect and, therefore you will not be able to connect to the data source.

Creating ODBC data source for Data Gateway

In this part we will create ODBC data source to connect to Data Gateway from Azure Data Factory (Pipeline). To achieve that, let's perform these steps:

  1. Open ODBC Data Sources (x64):

    Open ODBC Data Source

  2. Create a User data source (User DSN) based on ODBC Driver 17 for SQL Server:

    ODBC Driver 17 for SQL Server
    Create new User DSN for ODBC Driver 17 for SQL Server
    If you don't see ODBC Driver 17 for SQL Server driver in the list, choose a similar version driver.

  3. Then set a Name of the data source (e.g. Gateway) and the address of the Data Gateway:

    GatewayDSN
    localhost,5000
    ODBC driver for SQL Server - Setting hostname and port
    Make sure you separate the hostname and port with a comma, e.g. localhost,5000.

  4. Proceed with authentication part:

    • Select SQL Server authentication
    • In Login ID field enter the user name you used in Data Gateway, e.g., john
    • Set Password to the one you configured in Data Gateway
    ODBC driver for SQL Server - Selecting SQL Authentication

  5. Then set the default database property to CustomApiDSN (the one we used in Data Gateway):

    CustomApiDSN
    ODBC driver for SQL Server - Selecting database

  6. Continue by checking Trust server certificate option:

    ODBC driver for SQL Server - Trusting certificate

  7. Once you do that, test the connection:

    ODBC driver for SQL Server - Testing connection

  8. If connection is successful, everything is good:

    ODBC driver for SQL Server - Testing connection succeeded

  9. Done!

We are ready to move to the final step. Let's do it!

Accessing data in Azure Data Factory (Pipeline) via Data Gateway

Finally, we are ready to read data from Custom API in Azure Data Factory (Pipeline) via Data Gateway. Follow these final steps:

  1. Go back to Azure Data Factory (Pipeline).

  2. Create a New Linked service:

    • In the Manage section (left menu).

    • Under Connections, select Linked services.

    • Click + New to create a new Linked service based on ODBC.

    Add new Linked service

  3. Select ODBC service:

    Add new ODBC service

  4. Configure new ODBC service. Use the same DSN name we used in the previous step and copy it to Connection string box:

    GatewayDSN
    DSN=GatewayDSN
    Configure new ODBC service

  5. Read the data the same way we discussed at the beginning of this article.

  6. That's it!

Now you can connect to Custom API data in Azure Data Factory (Pipeline) via the Data Gateway.

If you are asked for authentication details, use Database authentication or SQL Authentication option and enter credentials you used when configuring Data Gateway, e.g. john and your password.

Conclusion

In this article we showed you how to connect to Custom API in Azure Data Factory (Pipeline) and integrate data without any coding, saving you time and effort.

We encourage you to download Custom API Connector for Azure Data Factory (Pipeline) and see how easy it is to use it for yourself or your team.

If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.

Download Custom API Connector for Azure Data Factory (Pipeline) Documentation

More integrations

Other connectors for Azure Data Factory (Pipeline)

All
Big Data & NoSQL
Database
CRM & ERP
Marketing
Collaboration
Cloud Storage
Reporting
Commerce
API & Files

Other application integration scenarios for Custom API

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications
Download Custom API Connector for Azure Data Factory (Pipeline) Documentation