Building a Custom API Connector for SSIS In this article you will learn how to quickly and efficiently integrate Custom API data in SSIS without coding. We will use high-performance Custom API Connector to easily connect to Custom API and then access the data inside SSIS. Read / write Custom API data in SSIS without coding. Let's follow the steps below to see how we can accomplish that! Download Documentation Building a Custom API Connector for SSIS is based on ZappySys API Connector Framework which is a part of SSIS PowerPack. It is a collection of high-performance SSIS connectors that enable you to integrate data with virtually any data provider supported by SSIS, including SQL Server. SSIS PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few (if you are new to SSIS and SSIS PowerPack, find out more on how to use them).

Connect to Custom API Connector in other apps Custom API Connector for SQL Server Custom API Connector for Power BI Custom API Connector for SSRS Custom API Connector for Informatica Custom API Connector for MS Access Custom API Connector for MS Excel Custom API Connector for SSAS Custom API Connector for C# Custom API Connector for Python Custom API Connector for JAVA Custom API Connector for Tableau Custom API Connector for SAP Crystal Reports Custom API Connector for Azure Data Factory (Pipeline) Custom API Connector for Azure Data Factory (SSIS) Custom API Connector for Talend Studio Custom API Connector for UiPath Custom API Connector for PowerShell Custom API Connector for ODBC

Video Tutorial - Integrate Custom API data in SSIS

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

• How to download / install required driver for Custom API integration in SSIS
• How to configure connection for Custom API
• Features about API Source (Authentication / Query Language / Examples / Driver UI)
• Using Custom API Connection in SSIS

Prerequisites

Before we begin, make sure the following prerequisites are met:

1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
3. SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).

Read data from Custom API in SSIS (Export data)

In this section we will learn how to configure and use Custom API Connector in API Source to extract data from Custom API.

1. Begin with opening Visual Studio and Create a New Project.

2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

3. In the new SSIS project screen you will find the following:

   1. SSIS ToolBox on left side bar
   2. Solution Explorer and Property Window on right bar
   3. Control flow, data flow, event Handlers, Package Explorer in tab windows
   4. Connection Manager Window in the bottom
   
   Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.

4. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.

   

5. From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
   

6. Select New Connection to create a new connection:
   

7. Once the next window opens, just click Continue >>:
   

8. Proceed with Connection Manager configuration. Choose 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.
   

9. Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.

   API Source - Custom API Connector

   Read / write Custom API data in SSIS without coding.

   

10. That's it! We are done! Just in a few clicks we configured the call to Custom API using Custom API Connector.

    You can load the source data into your desired destination using the Upsert Destination, which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV, Excel, Azure Table, Salesforce, and more. You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)

    

Write data to Custom API using SSIS (Import data)

In this section we will learn how to configure and use Custom API Connector in the API Destination to write data to Custom API.

Video tutorial

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

• How to download SSIS PowerPack for Custom API integration in SSIS
• How to configure connection for Custom API
• How to write or lookup data to Custom API
• Features about SSIS API Destination
• Using Custom API Connector in SSIS

Step-by-step instructions

In upper section we learned how to read data, now in this section we will learn how to configure Custom API in the API Source to POST data to the Custom API.

1. Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.

2. From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
   

3. Select New Connection to create a new connection:
   

   API Destination - Custom API

   Read / write Custom API data in SSIS without coding.

   

4. Once the next window opens, just click Continue >>:
   

5. Proceed with Connection Manager configuration. Choose 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.
   

6. Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.

   API Destination - Custom API

   Read / write Custom API data in SSIS without coding.

   

7. Finally, map the desired columns:

   API Destination - Custom API

   Read / write Custom API data in SSIS without coding.

   

8. That's it; we successfully configured the POST API Call. In a few clicks we configured the Custom API API call using ZappySys Custom API Connector

   

Load Custom API data into SQL Server using Upsert Destination (Insert or Update)

Once you configured the data source, you can load Custom API data into SQL Server using Upsert Destination.

Upsert Destination can merge or synchronize source data with the target table. It supports Microsoft SQL Server, PostgreSQL, and Redshift databases as targets. Upsert Destination also supports very fast bulk upsert operation along with bulk delete.

1. From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.

2. Connect your SSIS source component to Upsert Destination.

3. Double-click on Upsert Destination component to open configuration window.

4. Start by selecting the Action from the list.

5. Next, select the desired target connection or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.

6. Then select a table from the Target Table list or click New button to create a new table based on the source columns.

7. Continue by checking Insert and Update options according to your scenario (e.g. if Update option is unchecked, no updates will be made).

8. Finally, click Map All button to map all columns and then select the Key columns to match the columns on:

   

9. Click OK to save the configuration.

10. Run the package and Custom API data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:

    

11. Done!

Deploy and schedule SSIS package

After you are done creating SSIS package, most likely, you want to deploy it to SQL Server Catalog and run it periodically. Just follow the instructions in this article:

• How to design, debug, deploy, schedule SSIS Package (In SQL Agent and Catalog)

Running SSIS package in Azure Data Factory (ADF)

To use SSIS PowerPack in ADF, you must first prepare Azure-SSIS Integration Runtime. Follow this link for detailed instructions:

• Preparing ADF instance to use SSIS PowerPack

Conclusion

In this article we showed you how to connect to Custom API in SSIS and integrate data without any coding, saving you time and effort. We encourage you to download Custom API Connector for SSIS 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 SSIS Documentation

More integrations

Other connectors for SSIS

Amazon Ads

Amazon Selling Partner (SP-API)

Asana

Azure DevOps

Cosmos DB

DropBox

ElasticSearch

FastSpring

Google Ads

Google BigQuery

Google Calendar

Google Drive

Google Sheets

Hubspot

Jira

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

OData

OneDrive

Outlook Mail (Office 365)

Power BI

ServiceNow

SharePoint Online

Shopify

Smartsheet

Stripe

YouTube

Zendesk

Zoho CRM

Zoho SalesIQ

Zoom

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Amazon S3 JSON File

Amazon S3 XML File

Amazon S3 CSV File

Azure Blob JSON File

Azure Blob XML File

Azure Blob CSV File

FTP/SFTP JSON File

FTP/SFTP XML File

FTP/SFTP CSV File

Build your own Custom API Connector

Other application integration scenarios for Custom API

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

C#

Python

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

PowerShell

ODBC

Common Searches: