Integrating SOAP APIs with Python: A Practical Guide

In this guide, we will explore how to integrate SOAP APIs using Python. We'll break down the process step-by-step and provide clear examples to help you understand how to make SOAP requests and handle responses effectively.
By Jamie

Understanding SOAP API Integration with Python

SOAP (Simple Object Access Protocol) is a messaging protocol used for exchanging structured information in web services. Integrating SOAP APIs with Python can be achieved using libraries like zeep or suds. In this guide, we’ll use zeep, a modern SOAP client for Python, to demonstrate integration through practical examples.

Prerequisites

Before you start, ensure you have the following:

  • Python installed on your machine (Python 3.x recommended)

  • The zeep library installed. You can install it using pip:

    pip install zeep

Example 1: Basic SOAP API Request

Let’s assume we want to consume a SOAP API that provides weather information. The WSDL (Web Services Description Language) URL for the service is http://www.webserviceX.NET/Weather.asmx?WSDL. Here’s how to make a simple SOAP request:

Step 1: Import the Library

from zeep import Client

Step 2: Initialize the Client

wsdl_url = 'http://www.webserviceX.NET/Weather.asmx?WSDL'
client = Client(wsdl=wsdl_url)

Step 3: Make a SOAP Request

Let’s fetch the weather by city name:

response = client.service.GetWeather('New York')

Step 4: Print the Response

print(response)

The above code will output the weather information for New York in a structured format.

Example 2: SOAP API Request with Parameters

In many cases, SOAP API requests require parameters. Let’s enhance our previous example by including more parameters for a weather report:

Step 1: Prepare the Request

Assuming the API also takes a country code:

city_name = 'Los Angeles'
country_code = 'US'

Step 2: Make the SOAP Request with Parameters

response = client.service.GetWeather(city_name, country_code)

Step 3: Display the Result

print(f'Weather in {city_name}, {country_code}: {response}')

Example 3: Handling SOAP Responses

Responses from SOAP APIs are often complex. Here’s how to navigate and extract specific information from the response:

Step 1: Make a Request

response = client.service.GetWeather('London')

Step 2: Extract Data

Assuming the response has a property Temperature:

temperature = response.Temperature
print(f'Temperature in London: {temperature}')

Conclusion

Integrating SOAP APIs with Python using the Zeep library is straightforward and efficient. By following the examples provided, you can easily connect to various SOAP services and retrieve the necessary data. For more complex integrations, refer to the official Zeep documentation to explore advanced features like authentication and data serialization.