Interfacing with SOAP APIs Using XML in Python

1. What is SOAP?

SOAP is a protocol designed for exchanging structured information in web services. Unlike REST, SOAP relies strictly on XML for message formatting and operates over application layer protocols like HTTP. SOAP messages are encapsulated within:

• Envelope: Defines the start and end of the message structure.
• Header: Optional block containing authentication or metadata.
• Body: Contains the actual method call payload or request data.

2. Python Library for SOAP: Zeep

The Zeep library is the modern standard for interacting with SOAP web services in Python. It parses WSDL (Web Services Description Language) files dynamically and generates the correct XML payloads automatically.

3. Example: Fetching Currency Conversion Rates

Below is a practical example demonstrating how to initialize a Zeep client and invoke a remote SOAP method:

Code Breakdown & Example

from zeep from Client

# WSDL URL for the SOAP API
wsdl_url = "http://www.webservicex.net/CurrencyConvertor.asmx?WSDL"

# Create a Zeep client
client = Client(wsdl=wsdl_url)

# Call the API method
source_currency = "USD"
target_currency = "INR"

try:
    conversion_rate = client.service.ConversionRate(source_currency, target_currency)
    print(f"Conversion rate from {source_currency} to {target_currency}: {conversion_rate}")
except Exception as e:
    print(f"Error occurred: {e}")

Explanation:

• Client(wsdl): Initializes the Zeep client using the remote WSDL specification.
• client.service.MethodName: Dynamically invokes remote SOAP functions as standard Python methods.
• Error Handling: Safely catches network timeouts or SOAP faults.

4. Common Operations with Zeep

• Inspecting Services: Use client.wsdl.services to inspect available ports and bindings.
• Dictionary Arguments: Pass complex nested data structures as standard Python dictionaries.
• Debugging Logs: Enable Python standard logging on zeep.transports to inspect raw XML sent over the wire.

5. Best Practices

• Endpoint Stability: Verify that WSDL endpoints remain active, as many legacy SOAP services are deprecated.
• Secure Credentials: Store WS-Security usernames and passwords in environment variables.
• Timeout Configuration: Always configure explicit transport timeouts to prevent blocked threads.

Conclusion

Interfacing with SOAP web services in Python is greatly simplified using modern libraries like Zeep. By handling XML serialization and WSDL parsing under the hood, developers can focus on core application logic.

Interactive Notebook & Practice Exercises

Practice SOAP API integration concepts in our companion Jupyter Notebook:

Interactive Companion Jupyter Notebook

Explore interactive code cells and test SOAP client setup and WSDL inspection.

View on GitHub

Subhendu Mohapatra

Author & Instructor at plus2net

I write and maintain practical tutorials on Python, PHP, SQL, JavaScript, HTML, jQuery, and web development at plus2net. The tutorials focus on clear explanations, working examples, and code that readers can test and adapt while learning.

About the author   Watch on YouTube

Connect: