Azure Data Factory (ADF) SOAP API Connector
In this article you will learn how to integrate
Using SOAP API Connector you will be able to connect, read, and write data from within Azure Data Factory (ADF). Follow the steps below to see how we would accomplish that.
Driver mentioned in this article is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc.
If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started.
What is SOAP Web Service?
If you are new to SOAP Web Service sometimes referred as XML Web Service then please read some concept about SOAP Web service standard from this link
There are two important aspects in SOAP Web service.
- Getting WSDL file or URL
- Knowing exact Web Service URL
What is WSDL
In very simple term WSDL (often pronounced as whiz-dull) is nothing but a document which describes Service metadata (e.g. Functions you can call, Request parameters, response structure etc). Some service simply give you WSDL as xml file you can download on local machine and then analyze or sometimes you may get direct URL (e.g. http://api.mycompany.com/hr-soap-service/?wsdl )
What is Service URL
Service URL is actual API URL you can call to get data. When you make a request to SOAP service url make sure following things.
- Use correct service URL (Its not same as WSDL url). If you are not sure about service URL contact API vendor or refer API documentation.
Each service call you have to supply function you want to call. This can be done in 3 different ways.
- Pass via SOAPAction HTTP Header
- Pass via Url parameter or Url Path (http://myserver/service/function1 — http://myserver/service/?method=function1 )
- Pass via Request BODY
- Find out how to pass credentials. It can be done via Basic Authorization or WSS Security Header in the Request body. Check this link to learn more
Using SoapUI to test SOAP API call / Create Request Body XML
If you do not have WSDL file or URL handy then contact your API provider (sometimes you just have to add ?wsdl at the end of your Service URL to get WSDL so try that. Example: http://mycompany/myservice?wsdl ). If you don't know what is WSDL then in short, WSDL is Web service Description Language (i.e. XML file which describes your SOAP Service). WSDL helps to craft SOAP API request Body for ZappySys XML Driver. So Let's get started.
- Download and Install SoapUI (It’s a Free tool to test SOAP / REST Services)
- Open SoapUI and click SOAP button to create new SOAP Project
Enter WSDL URL or File Path of WSDLFor example WSDL for our sample service can be accessed via this URL
http://www.holidaywebservice.com/HolidayService_v2/HolidayService2.asmx?wsdlCreate new SOAP API Project in SoapUI tool for SOAP API Testing
- Once WSDL is loaded you will see possible operations you can call for your SOAP Web Service.
If your web service requires credentials then you have to configure it. There are two common credential types for public services (SOAP WSS or BASIC )
To use SOAP WSS Credentials select request node and enter UserId, Password, and WSS-PasswordType (PasswordText or PasswordHash)Configure SOAP WSS Credentials for SoapUI (SOAP API Testing Tool)
To use BASIC Auth Credentials select request node and double-click it. At the bottom click on Auth (Basic) and From Authorization dropdown click Add New and Select Basic.
Configure Basic Authorization for SoapUI (SOAP API Testing Tool)
- Now you can test your request first Double-click on the request node to open request editor.
Change necessary parameters, remove optional or unwanted parameters. If you want to regenerate request you can click on Recreate default request toolbar icon.
Create SOAP Request XML (With Optional Parameters)
Once your SOAP Request XML is ready, Click the Play button in the toolbar to execute SOAP API Request and Response will appear in Right side panel.
Test SOAP API using SoapUI Tool (Change Default XML Body / Parameters, Execute and See Response)
Once you have tested your SOAP API in SoapUI tool, we are ready to use ZappySys SSIS Tasks/Components or ODBC Drivers to call SOAP API in SSIS or your preferred BI tool or Programming language.
Create ODBC Data Source (DSN) based on ZappySys XML Driver
To get data from Soapapi using Azure Data Factory (ADF) we first need to create a DSN (Data Source) which will access data from Soapapi. We will later be able to read data using Azure Data Factory (ADF). Perform these steps:
Install ZappySys ODBC PowerPack.
Open ODBC Data Sources (x64):
Create a System Data Source (System DSN) based on ZappySys XML DriverZappySys XML DriverYou should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version. Furthermore, a User DSN may be created instead, but then you will not be able to use the connection from Windows Services (or any application running under a Windows System Account).
Configure API URL, Request Method and Request Body as below screen. Select Url or File and paste the following Url for this example.
NOTE: Here i am using demo SOAP API URL, but you need to refer your own API documentation and based on that you need to use your own API URL and need to configure connection based on API Authentication type.http://www.holidaywebservice.com/HolidayService_v2/HolidayService2.asmx?wsdl
(This step is Optional) If your SOAP API requires credentials then Select Connection Type to HTTP and configure as below.
Configure-Request Headers as below (You can get it from Request > Raw tab from SoapUI after you test the request by clicking the Play button)
Once credentials entered you can select Filter to extract data from the desired node. Make sure to select array node (see special icon) or select the node which contains all necessary columns if you don't have array node.
If prompted select yes to treat selected node as Array (This is helpful when you expect one or more record for selected node)
Once the data source has been configured, Go to Preview tab and click on preview data to view the data.
You can create the default query, generated based on settings you entered in previous sections also, by using Query Builder. Attributes listed in WITH clause are optional. If you omit attribute in WITH clause it will use it from Properties tab.
Click OK to finish creating the data source.
That's it; we are done. In a few clicks we configured the call to SOAP API using ZappySys SOAP Connector.
Read data in Azure Data Factory (ADF) from ODBC datasource (SOAP API)
To start press New button:
Select "Azure, Self-Hosted" option:
Select "Self-Hosted" option:
Set a name, we will use "OnPremisesRuntime":
Download and install Microsoft Integration Runtime.
Launch Integration Runtime and copy/paste Authentication Key from Integration Runtime configuration in Azure Portal:
After finishing registering the Integration Runtime node, you should see a similar view:
Go back to Azure Portal and finish adding new Integration Runtime. You should see it was successfully added:
Go to Linked services section and create a new Linked service based on ODBC:
Select "ODBC" service:
Configure new ODBC service. Use the same DSN name we used in the previous step and copy it to Connection string box:SoapapiDSNDSN=SoapapiDSN
For created ODBC service create ODBC-based dataset:
Go to your pipeline and add Copy data connector into the flow. In Source section use OdbcDataset we created as a source dataset:
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:
Finally, run the pipeline and see data being transferred from OdbcDataset to your destination dataset:
Create Custom Store Procedure in ZappySys Driver
You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.
Steps to create Custom Store Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
Enter the desired Procedure name and click on OK:
Select the created Store Procedure and write the your desired store procedure and Save it and it will create the custom store procedure in the ZappySys Driver:
Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
CREATE PROCEDURE [usp_get_orders] @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>' AS SELECT * FROM Orders where OrderDate >= '<@fromdate>';
That's it now go to Preview Tab and Execute your Store Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
Exec usp_get_orders '1996-01-01';
Create Custom Virtual Table in ZappySys Driver
ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.
Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.
Go to Custom Objects Tab and Click on Add button and Select Add Table:
Enter the desired Table name and click on OK:
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
SELECT "ShipCountry", "OrderID", "CustomerID", "EmployeeID", "OrderDate", "RequiredDate", "ShippedDate", "ShipVia", "Freight", "ShipName", "ShipAddress", "ShipCity", "ShipRegion", "ShipPostalCode" FROM "Orders" Where "ShipCountry"='USA'
That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
SELECT * FROM "vt__usa_orders_only"
ConclusionIn this article we discussed how to connect to SOAP API in Azure Data Factory (ADF) and integrate data without any coding. Click here to Download SOAP API Connector for Azure Data Factory (ADF) 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 SOAP API Connector for Azure Data Factory (ADF)
Other App Integration scenarios for SOAP API
Other Connectors for Azure Data Factory (ADF)
Download SOAP API Connector for Azure Data Factory (ADF) Documentation
How to connect SOAP API in Azure Data Factory (ADF)?
How to get SOAP API data in Azure Data Factory (ADF)?
How to read SOAP API data in Azure Data Factory (ADF)?
How to load SOAP API data in Azure Data Factory (ADF)?
How to import SOAP API data in Azure Data Factory (ADF)?
How to pull SOAP API data in Azure Data Factory (ADF)?
How to push data to SOAP API in Azure Data Factory (ADF)?
How to write data to SOAP API in Azure Data Factory (ADF)?
How to POST data to SOAP API in Azure Data Factory (ADF)?
Call SOAP API API in Azure Data Factory (ADF)
Consume SOAP API API in Azure Data Factory (ADF)
SOAP API Azure Data Factory (ADF) Automate
SOAP API Azure Data Factory (ADF) Integration
Integration SOAP API in Azure Data Factory (ADF)
Consume real-time SOAP API data in Azure Data Factory (ADF)
Consume realtime SOAP API API data in Azure Data Factory (ADF)
SOAP API ODBC Driver | ODBC Driver for SOAP API | ODBC SOAP API Driver | SSIS SOAP API Source | SSIS SOAP API Destination
Connect SOAP API in Azure Data Factory (ADF)
Load SOAP API in Azure Data Factory (ADF)
Load SOAP API data in Azure Data Factory (ADF)
Read SOAP API data in Azure Data Factory (ADF)
SOAP API API Call in Azure Data Factory (ADF)