Building a Custom API Connector for Azure Data Factory (SSIS) Read / write Custom API data in Azure Data Factory (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 SSIS 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 Talend Studio Custom API Connector for UiPath Custom API Connector for PowerShell Custom API Connector for ODBC

Create SSIS package

First of all, create an SSIS package, which will connect to Custom API Connector in SSIS. Once you do that, you are one step closer to deploying and running it in Azure-SSIS integration runtime in Azure Data Factory (ADF). Then simply proceed to the next step - creating and configuring Azure Blob Storage Container.

Prepare custom setup files for Azure-SSIS runtime

Now it's time to start preparing custom setup files for Azure-SSIS runtime. During Azure-SSIS runtime creation you can instruct ADF to perform a custom setup on a VM (Azure-SSIS node); i.e. to run the custom installer, copy files, execute PowerShell scripts, etc. In that case, your custom setup files are downloaded and run in the Azure-SSIS node (a VM) when you start the runtime. In this section we will prepare custom setup files so that you can run SSIS packages with SSIS PowerPack connectors inside in Azure-SSIS runtime.

Trial Users

Use the step below if you are a Trial User, when you did not purchase a license key. Proceed with these steps:

1. Download SSIS PowerPack trial installer.
   Make sure you don't rename the installer and keep it named as SSISPowerPackSetup_64bit_Trial.msi.
2. Create a text file and name it main.cmd (make it all lowercase, very important).
3. Copy and paste this script into it and save it:

   set DIR=%CUSTOM_SETUP_SCRIPT_LOG_DIR%
   
   echo Calling Step 1 : %TIME% >> "%DIR%\steps_log.txt"
   dir /s /b > "%DIR%\file_list.txt"
   
   echo Calling Step 2 : %TIME% >> "%DIR%\steps_log.txt"
   
   ::Install SSIS PowerPack
   msiexec /i  "SSISPowerPackSetup_64bit_Trial.msi" ADDLOCAL=ALL /q  /L*V "%DIR%\powerpack_trial_install_log.txt"
   
   echo Calling Step 3 : %TIME% >> "%DIR%\steps_log.txt"
   dir "C:\Program Files\Microsoft SQL Server\*Zappy*.*"  /s /b >> "%DIR%\installed_files.txt"
   dir "C:\Program Files (x86)\Microsoft SQL Server\*Zappy*.*"  /s /b >> "%DIR%\installed_files.txt"
   
   echo DONE : %TIME% >> "%DIR%\steps_log.txt"
   
   echo complete

   This is the entry-point script that is executed when Azure-SSIS runtime is started.
4. At last! You are ready to upload these two files — main.cmd & SSISPowerPackSetup_64bit_Trial.msi — into your Azure Blob Storage container's folder, which we will do in the Upload custom setup files to Azure Blob Storage container step.

Paid Customers

Use the steps below if you are a Paid Customer, when you purchased a license. Proceed with these steps:

1. Download SSIS PowerPack paid installer.
   Make sure you don't rename the installer and keep it named as SSISPowerPackSetup_64bit.msi.
2. Have your SSIS PowerPack license key handy, we will need it in the below script.
3. Create a text file and name it main.cmd (make it all lowercase, very important).
4. Copy and paste the below script into it.
5. Paste your license key by replacing parameter's --register argument with your real license key.
6. Finally, save main.cmd:

   set DIR=%CUSTOM_SETUP_SCRIPT_LOG_DIR%
   
   echo Calling Step 1 : %TIME% >> "%DIR%\steps_log.txt"
   dir /s /b > "%DIR%\file_list.txt"
   
   echo Calling Step 2 : %TIME% >> "%DIR%\steps_log.txt"
   
   ::Install SSIS PowerPack
   msiexec /i  "SSISPowerPackSetup_64bit.msi" ADDLOCAL=ALL /q  /L*V "%DIR%\powerpack_install_log.txt"
   
   echo Calling Step 3 : %TIME% >> "%DIR%\steps_log.txt"
   
   ::Activate PowerPack license (Optional)
   "C:\Program Files (x86)\ZappySys\SSIS PowerPack (64 bit)\LicenseManager.exe" -p SSISPowerPack --register "lgGAAO0-----REPLACE-WITH-YOUR-LICENSE-KEY-----czM=" --logfile "%DIR%\powerpack_register_log.txt"
   
   ::Show System Info
   echo Calling Step 4 : %TIME% >> "%DIR%\steps_log.txt"
   "C:\Program Files (x86)\ZappySys\SSIS PowerPack (64 bit)\LicenseManager.exe" -i -l "%DIR%\sysinfo_log.txt"
   
   echo Calling Step 5 : %TIME% >> "%DIR%\steps_log.txt"
   dir "C:\Program Files\Microsoft SQL Server\*Zappy*.*"  /s /b >> "%DIR%\installed_files.txt"
   dir "C:\Program Files (x86)\Microsoft SQL Server\*Zappy*.*"  /s /b >> "%DIR%\installed_files.txt"
   
   echo DONE : %TIME% >> "%DIR%\steps_log.txt"
   
   echo complete

   This is the entry-point script that is executed when Azure-SSIS runtime is started.
7. At last! You are ready to upload these two files — main.cmd & SSISPowerPackSetup_64bit.msi — into your Azure Blob Storage container's folder, which we will do in the Upload custom setup files to Azure Blob Storage container step.

Upload custom setup files to Azure Blob Storage container

Within Azure Blob Storage container we will store custom setup files we prepared in the previous step so that Azure-SSIS can use them in custom setup process. Just perform these very simple, but very important steps:

1. Create Azure Blob Storage container, if you haven't done it already
   Make sure you create and use Azure Blob Storage container instead of Azure Data Lake Storage folder. Azure Data Lake Storage won't allow creating an SAS URI for the container, which is a crucial step in the process.
2. Find Blob Containers node, right-click on it and hit Create Blob Container option:
3. Upload the two custom setup files — main.cmd & the MSI installer — into your Azure Blob Storage container's folder:
4. It was easy, wasn't it? It's time we create an SAS URI in the next step.

Create SAS URI for Azure Blob Container

Once you have custom setup files prepared, it's time we generate an SAS URI. This SAS URI will be used by a new Azure-SSIS runtime to install SSIS PowerPack inside the runtime's node, a VM. Let's proceed together by performing the steps below:

1. Install and launch Azure Storage Explorer.
2. Right-click on the Storage Accounts node and then hit Connect to Azure storage... menu item:
3. Proceed by right-clicking on that container node and select Get Shared Access Signature... option.
4. Next, set the Expiry time field to a date far in the future.
   If you restart Azure-SSIS runtime and your SAS URI is expired by that time, it will not start.
5. Select Read, Create, Write, and List permissions:
   We also recommend to add Delete permission too to support future functionality.
6. Copy SAS URL to the clipboard and save it for the next step: You can also generate and copy SAS URL from within Azure Portal itself:

Create Azure-SSIS integration runtime

Once you have the SAS URL we obtained in the previous step, we are ready to move on to create an Azure-SSIS runtime in Azure Data Factory:

1. Firstly, perform the steps described in Create an Azure-SSIS integration runtime article in Azure Data Factory reference.
2. In Advanced settings page section, configure Custom setup container SAS URI you obtained in the previous step:
3. And you are done! That was quick! You can see your Azure-SSIS runtime up and running:

Deploy SSIS package in Visual Studio

We are ready to deploy the SSIS package to Azure-SSIS runtime. Once you do that, proceed to the next step for the grand finale!

Execute SSIS package in SQL Server Management Studio (SSMS)

After all hard work, we are ready to execute SSIS package in SQL Server Management Studio (SSMS):

1. Connect to the SQL Server which is linked to your Azure-SSIS runtime and contains SSISDB database.
2. Navigate to Integration Services Catalog » Your Folder » Your Project » Your Package, right-click on it, and hit Execute...:
3. To view the status of the past execution, navigate to Integration Services Catalog » Your Folder » Your Project » Your Package, right-click on it, and select Reports » Standard Reports » All Executions menu item:

Scenarios

Moving SSIS PowerPack license to another Azure-SSIS runtime

If you are a Paid Customer, there will be a time when you no longer use Azure-SSIS runtime or you need to use your license on a different ADF instance. To transfer a license from one Azure-SSIS runtime to another, perform these steps:

1. Copy & paste this script into main.cmd we used in the previous step:

   set DIR=%CUSTOM_SETUP_SCRIPT_LOG_DIR%
   
   echo Calling Step 1 : %TIME% >> "%DIR%\steps_log.txt"
   dir /s /b > "%DIR%\file_list.txt"
    
   echo Calling Step 2 : %TIME% >> "%DIR%\steps_log.txt"
   
   ::Install SSIS PowerPack
   msiexec /i  "SSISPowerPackSetup_64bit.msi" ADDLOCAL=ALL /q  /L*V "%DIR%\powerpack_install_log.txt"
    
   echo Calling Step 3 : %TIME% >> "%DIR%\steps_log.txt"
    
   ::De-Activate same license
   "C:\Program Files (x86)\ZappySys\SSIS PowerPack (64 bit)\LicenseManager.exe" -p SSISPowerPack --unregister --logfile "%DIR%\powerpack_un_register_log.txt"
    
   ::Show System Info
   echo Calling Step 4 : %TIME% >> "%DIR%\steps_log.txt"
   "C:\Program Files (x86)\ZappySys\SSIS PowerPack (64 bit)\LicenseManager.exe" -i -l "%DIR%\sysinfo_log.txt"
    
   echo Calling Step 5 : %TIME% >> "%DIR%\steps_log.txt"
   dir "C:\Program Files\Microsoft SQL Server\*Zappy*.*"  /s /b >> "%DIR%\installed_files.txt"
   dir "C:\Program Files (x86)\Microsoft SQL Server\*Zappy*.*"  /s /b >> "%DIR%\installed_files.txt"
    
   echo DONE : %TIME% >> "%DIR%\steps_log.txt"
    
   echo complete

2. Start Azure-SSIS runtime.
   This will unregister your license on the original Azure-SSIS runtime.
3. Stop Azure-SSIS runtime to deallocate resources in Azure.
4. Now you are free to activate it on another Azure-SSIS runtime.

Conclusion

In this article we discussed how to connect to Custom API in Azure Data Factory (SSIS) and integrate data without any coding. Click here to Download Custom API Connector for Azure Data Factory (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 Azure Data Factory (SSIS) Documentation 

More integrations

Other application integration scenarios for Custom API

SSIS

SQL Server

Power BI

SSRS

Informatica

MS Access

MS Excel

SSAS

C#

Python

JAVA

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Talend Studio

UiPath

PowerShell

ODBC

Other connectors for Azure Data Factory (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 Azure Data Factory (SSIS) Documentation

Common Searches: