Building a Custom API Connector for SSIS Read / write Custom API data in SSIS without coding. You can use this connector to integrate Custom API Connector data inside SSIS and SQL Server. Let's take a look at the steps below to see how exactly to accomplish that. Download Documentation If you are new with SSIS and ZappySys SSIS PowerPack then check below links to get started. How to get started with SSIS and SSIS PowerPack. it covers how to install necessary tools to design/debug SSIS Packages, deploy to SSIS catalog and last Schedule SSIS Package to run using SQL Agent. It will also cover how to secure SSIS package and Parameterize values (e.g. Password, Hostname, etc). SSIS API Source Help File SSIS API Destination Help File

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

How to 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)

    

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

Once you read data from the desired source, now let's see how to Load Custom API data in SQL Server using Upsert Destination. Upsert Destination can Merge/Synchronize data from source to target for Microsoft SQL Server, PostgreSql and Redshift. It supports very fast Bulk Upsert (Update or Insert) operation along and Bulk delete.

1. From the SSIS toolbox drag and drop Upsert Destination on the dataflow designer surface
   

2. Connect our Source component to Upsert Destination

3. Double click on Upsert Destination component to configure it.

4. Select the desired Microsoft SQL Server/PostgreSql/Redshift Target Connection or click NEW to create new connection. Select Target Table or click NEW to create new table based on source columns.
   
   Configure SSIS Upsert Destination Connection - Loading data (REST / SOAP / JSON / XML /CSV) into SQL Server or other target using SSIS

5. Set Action to Upsert => (insert if not matching in target else update). Select Target Connection and Target Table. Check on Insert and Update. Click on Map All to Mappings all columns and check on Only Primary Key columns.
   

6. Click on OK to save Upsert Destination settings UI.

7. That's it. Run the SSIS Package and it will read the data from the Custom API and load the data in the SQL Server/PostgreSql/Redshift using Upsert Destination.

   

Video Tutorial - Write or lookup data to Custom API using SSIS

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

How to write or lookup data to Custom API in SSIS (Import data)

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

   

Conclusion

In this article we discussed how to connect to Custom API in SSIS and integrate data without any coding. Click here to Download Custom API Connector for SSIS and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).

Download Custom API Connector for SSIS Documentation 

More integrations

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

Other connectors for SSIS

Amazon Ads

Amazon MWS

Amazon Selling Partner (SP-API)

Asana

Azure DevOps

Cosmos DB

DropBox

ElasticSearch

FastSpring

Google BigQuery

Google Calendar

Google Drive

Google Sheets

Hubspot

Jira

Mailchimp

ManagedEngine ServiceDesk Plus (Zoho)

Nativo

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

Download Custom API Connector for SSIS Documentation

Common Searches: