SOAP API Connector for JAVA

In this article you will learn how to quickly and efficiently integrate SOAP API data in JAVA. We will use high-performance SOAP API Connector to easily connect to SOAP API and then access the data inside JAVA.

SOAP Connector can be used to consume data from XML SOAP Service without any programming. It supports advanced filtering along with flexible approach to configure request parameters for web service.

Let's follow the steps below to see how we can accomplish that!

Download Documentation

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

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.

  1. Getting WSDL file or URL
  2. 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.

  1. 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.
  2. Each service call you have to supply function you want to call. This can be done in 3 different ways.
    1. Pass via SOAPAction HTTP Header
    2. Pass via Url parameter or Url Path (http://myserver/service/function1  — http://myserver/service/?method=function1 )
    3. Pass via Request BODY
  3. 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.

  1. Download and Install SoapUI (It’s a Free tool to test SOAP / REST Services)
  2. Open SoapUI and click SOAP button to create new SOAP Project
  3. 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?wsdl
    Create new SOAP API Project in SoapUI tool for SOAP API Testing
    Create new SOAP API Project in SoapUI tool for SOAP API Testing
  4. Once WSDL is loaded you will see possible operations you can call for your SOAP Web Service.
  5. 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 )
    1. 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)
      Configure SOAP WSS Credentials for SoapUI (SOAP API Testing Tool)
    2. 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)
      Configure Basic Authorization for SoapUI (SOAP API Testing Tool)
  6. Now you can test your request first Double-click on the request node to open request editor.
  7. 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)
    Create SOAP Request XML (With Optional Parameters)
  8. 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)
    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 Data Source in ZappySys Data Gateway based on XML Driver

  1. Download and install ZappySys ODBC PowerPack.

  2. Search for gateway in start menu and Open ZappySys Data Gateway:
    Open ZappySys Data Gateway

  3. Go to Users Tab to add our first Gateway user. Click Add; we will give it a name tdsuser and enter password you like to give. Check Admin option and click OK to save. We will use these details later when we create linked server:
    ZappySys Data Gateway - Add User

  4. Now we are ready to add a data source. Click Add, give data source a name (Copy this name somewhere, we will need it later) and then select Native - ZappySys XML Driver. Finally, click OK. And it will create the Data Set for it and open the ZS driver UI.

    ZappySys Data Gateway - Add XML Data Source

  5. Configure API URL, Request Method and Request Body as below screen. Select Url or File and paste the following Url for this example OR you can load existing connection string as per this article.

    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

    ZappySys XML Driver - Calling SOAP API - Configure URL, Method, Body
    ZappySys XML Driver - Calling SOAP API - Configure URL, Method, Body

  6. (This step is Optional) If your SOAP API requires credentials then Select Connection Type to HTTP and configure as below.

    ZappySys XML Driver - Configure SOAP WSS Credentials or Basic Authorization (Userid, Password)
    ZappySys XML Driver - Configure SOAP WSS Credentials or Basic Authorization (Userid, Password)

  7. 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)

    Configure SOAP API Request Headers - ZappySys XML Driver
    Configure SOAP API Request Headers - ZappySys XML Driver

  8. 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.

    Select Filter - Extract data from nested XML / SOAP API Response (Denormalize Hierarchy)
    Select Filter - Extract data from nested XML / SOAP API Response (Denormalize Hierarchy)

  9. If prompted select yes to treat selected node as Array (This is helpful when you expect one or more record for selected node)

    Treat selected node as XML Array Option for SOAP API Response XML
    Treat selected node as XML Array Option for SOAP API Response XML

  10. 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.

    Preview SOAP API Response in ZappySys XML Driver
    Preview SOAP API Response in ZappySys XML Driver

  11. Click OK to finish creating the data source.

  12. That's it; we are done. In a few clicks we configured the call to SOAP API using ZappySys SOAP Connector.

Read data in Java from the DSN

  1. Java code to get the data:

    "jdbc:sqlserver://localhost:5000;databasename=SoapApiDSN;user=tdsuser;password=test"
    Java code to Make ZappySys Driver Data Source Call

  2. When you run the code it will make the API call and read the data:
    Java code ZappySys Driver Data Source Results

  3. Here is Java program's code in text format: 

    
//Step-1: Install ZappySys ODBC PowerPack and Configure Data Gateway

//Step-2:Assuming the Microsoft SQL Server JDBC Driver is in below folder
//C:\Program Files\Microsoft Jdbc Driver 6.0 for SQL Server\sqljdbc_6.0\enu\auth\x64
package padaone;

import java.sql.*;

public class zappy {

    public static void main(String[] args) {

        // Create a variable for the connection string.
        String connectionUrl = "jdbc:sqlserver://localhost:5000;databasename=SoapApiDSN;user=test;password=test";

        // Declare the JDBC objects.
        Connection con = null;
        Statement stmt = null;
        ResultSet rs = null;

            try {
                // Establish the connection.
                Class.forName("com.microsoft.sqlserver.jdbc.SQLServerDriver");
                con = DriverManager.getConnection(connectionUrl);

                // Create and execute an SQL statement that returns some data.
                String SQL = "SELECT Country , SUM(UnitPrice * Quantity) Total " 
                           + "FROM value " 
                           + "GROUP BY Country "
                           + "WITH (SRC='https://services.odata.org/V3/Northwind/Northwind.svc/Invoices?$format=json')";
                stmt = con.createStatement();
                rs = stmt.executeQuery(SQL);

                // Iterate through the data in the result set and display it.
                while (rs.next()) {
                    System.out.println(rs.getString(1) + " " + rs.getString(2));
                }
            }

        // Handle any errors that may have occurred.
        catch (Exception e) {
            e.printStackTrace();
        } 
        
        finally {
            if (rs != null) try { rs.close(); } catch (Exception e) {}
            if (stmt != null) try { stmt.close(); } catch (Exception e) {}
            if (con != null) try { con.close(); } catch (Exception e) {}
        }
    }
}

Configuring pagination in the XML Driver

ZappySys XML Driver equips users with powerful tools for seamless data extraction and management from REST APIs, leveraging advanced pagination methods for enhanced efficiency. These options are designed to handle various types of pagination structures commonly used in APIs. Below are the detailed descriptions of these options:

  1. Page-based Pagination: This method works by retrieving data in fixed-size pages from the Rest API. It allows you to specify the page size and navigate through the results by requesting different page numbers, ensuring that you can access all the data in a structured manner.

  2. Offset-based Pagination: With this approach, you can extract data by specifying the starting point or offset from which to begin retrieving data. It allows you to define the number of records to skip and fetch subsequent data accordingly, providing precise control over the data extraction process.

  3. Cursor-based Pagination: This technique involves using a cursor or a marker that points to a specific position in the dataset. It enables you to retrieve data starting from the position indicated by the cursor and proceed to subsequent segments, ensuring that you capture all the relevant information without missing any records.

  4. Token-based Pagination: In this method, a token serves as a unique identifier for a specific data segment. It allows you to access the next set of data by using the token provided in the response from the previous request. This ensures that you can systematically retrieve all the data segments without duplication or omission.

Utilizing these comprehensive pagination features in the ZappySys XML Driver facilitates efficient data management and extraction from REST APIs, optimizing the integration and analysis of extensive datasets.

For more detailed steps, please refer to this link: How to do REST API Pagination in SSIS / ODBC Drivers

Authentication

ZappySys offers various authentication methods to securely access data from various sources. These authentication methods include OAuth, Basic Authentication, Token-based Authentication, and more, allowing users to connect to a wide range of data sources securely.

ZappySys Authentication is a robust system that facilitates secure access to data from a diverse range of sources. It includes a variety of authentication methods tailored to meet the specific requirements of different data platforms and services. These authentication methods may involve:

  1. OAuth: ZappySys supports OAuth for authentication, which allows users to grant limited access to their data without revealing their credentials. It's commonly used for applications that require access to user account information.

  2. Basic Authentication: This method involves sending a username and password with every request. ZappySys allows users to securely access data using this traditional authentication approach.

  3. Token-based Authentication: ZappySys enables users to utilize tokens for authentication. This method involves exchanging a unique token with each request to authenticate the user's identity without revealing sensitive information.

By implementing these authentication methods, ZappySys ensures the secure and reliable retrieval of data from various sources, providing users with the necessary tools to access and integrate data securely and efficiently. For more comprehensive details on the authentication process, please refer to the official ZappySys documentation or reach out to their support team for further assistance.

For more details, please refer to this link: ZappySys Connections

Advanced topics

Create Custom Stored 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 Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here

  1. Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
    ZappySys Driver - Add Stored Procedure

  2. Enter the desired Procedure name and click on OK:
    ZappySys Driver - Add Stored Procedure Name

  3. Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored 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>';

    ZappySys Driver - Create Custom Stored Procedure

  4. That's it now go to Preview Tab and Execute your Stored 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';

    ZappySys Driver - Execute Custom Stored Procedure

  5. Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder. 

    SELECT * FROM OPENQUERY([LINKED_SERVER_TO_SOAP_API_IN_DATA_GATEWAY], 'EXEC usp_get_orders @fromdate=''1996-07-30''')

    ZappySys Driver - Generate SQL Server Query

  6. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

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.

If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.

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.

  1. Go to Custom Objects Tab and Click on Add button and Select Add Table:
    ZappySys Driver - Add Table

  2. Enter the desired Table name and click on OK:
    ZappySys Driver - Add Table Name

  3. And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.

  4. 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'

    ZappySys Driver - Create Custom Table

  5. 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"

    ZappySys Driver - Execute Custom Virtual Table Query

  6. Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
    As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder. 

    SELECT * FROM OPENQUERY([LINKED_SERVER_TO_SOAP_API_IN_DATA_GATEWAY], 'EXEC [usp_get_orders] ''1996-01-01''')

    ZappySys Driver - Generate SQL Server Query

  7. Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
    ZappySys Driver - Generate SQL Server Query

Conclusion

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

More integrations

Other connectors for JAVA

Other application integration scenarios for SOAP API

Soap for SSIS
SSIS
Soap for SQL Server
SQL Server
Soap for Power BI
Power BI
Soap for SSRS
SSRS
Soap for Informatica
Informatica
Soap for MS Access
MS Access
Soap for MS Excel
MS Excel
Soap for SSAS
SSAS
Soap for C#
C#
Soap for Python
Python
Soap for Tableau
Tableau
Soap for SAP Crystal Reports
SAP Crystal Reports
Soap for Azure Data Factory (Pipeline)
Azure Data Factory (Pipeline)
Soap for Azure Data Factory (SSIS)
Azure Data Factory (SSIS)
Soap for Talend Studio
Talend Studio
Soap for UiPath
UiPath
Soap for PowerShell
PowerShell
Soap for ODBC
ODBC
Download SOAP API Connector for JAVA Documentation

  • How to connect SOAP API in JAVA?

  • How to get SOAP API data in JAVA?

  • How to read SOAP API data in JAVA?

  • How to load SOAP API data in JAVA?

  • How to import SOAP API data in JAVA?

  • How to pull SOAP API data in JAVA?

  • How to push data to SOAP API in JAVA?

  • How to write data to SOAP API in JAVA?

  • How to POST data to SOAP API in JAVA?

  • Call SOAP API API in JAVA

  • Consume SOAP API API in JAVA

  • SOAP API JAVA Automate

  • SOAP API JAVA Integration

  • Integration SOAP API in JAVA

  • Consume real-time SOAP API data in JAVA

  • Consume real-time SOAP API API data in JAVA

  • 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 JAVA

  • Load SOAP API in JAVA

  • Load SOAP API data in JAVA

  • Read SOAP API data in JAVA

  • SOAP API API Call in JAVA