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 perform steps listed in this article, you will need to make sure following prerequisites are met:- SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft site).
- Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
- Make sure ZappySys SSIS PowerPack is downloaded and installed (download it). Check Getting started section for more information.
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.
-
Begin with opening Visual Studio and Create a New Project.
Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.
-
In the new SSIS project screen you will find the following:
- SSIS ToolBox on left side bar
- Solution Explorer and Property Window on right bar
- Control flow, data flow, event Handlers, Package Explorer in tab windows
- 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. -
Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
-
From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
-
Select New Connection to create a new connection:
-
Once the next window opens, just click Continue >>:
-
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.
-
Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.
API Source - Custom API ConnectorRead / write Custom API data in SSIS without coding.
-
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.
-
Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.
-
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.
-
Select New Connection to create a new connection:
API Destination - Custom APIRead / write Custom API data in SSIS without coding.
-
Once the next window opens, just click Continue >>:
-
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.
-
Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.
API Destination - Custom APIRead / write Custom API data in SSIS without coding.
-
Finally, map the desired columns:
API Destination - Custom APIRead / write Custom API data in SSIS without coding.
-
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 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.
-
From the SSIS toolbox drag and drop Upsert Destination on the dataflow designer surface
Connect our Source component to Upsert Destination
-
Double click on Upsert Destination component to configure it.
-
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 -
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.
-
Click on OK to save Upsert Destination settings UI.
-
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.
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 How to design, debug, deploy, schedule SSIS Package (In SQL Agent and Catalog) article to see how to do it.
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
Other connectors for SSIS
Download Custom API Connector for SSIS
Documentation
How to connect Custom API Connector in SSIS?
How to get Custom API Connector data in SSIS?
How to read Custom API Connector data in SSIS?
How to load Custom API Connector data in SSIS?
How to import Custom API Connector data in SSIS?
How to pull Custom API Connector data in SSIS?
How to push data to Custom API Connector in SSIS?
How to write data to Custom API Connector in SSIS?
How to POST data to Custom API Connector in SSIS?
Call Custom API Connector API in SSIS
Consume Custom API Connector API in SSIS
Custom API Connector SSIS Automate
Custom API Connector SSIS Integration
Integration Custom API Connector in SSIS
Consume real-time Custom API Connector data in SSIS
Consume real-time Custom API Connector API data in SSIS
Custom API Connector ODBC Driver | ODBC Driver for Custom API Connector | ODBC Custom API Connector Driver | SSIS Custom API Connector Source | SSIS Custom API Connector Destination
Connect Custom API Connector in SSIS
Load Custom API Connector in SSIS
Load Custom API Connector data in SSIS
Read Custom API Connector data in SSIS
Custom API Connector API Call in SSIS