SOAP
This connector provides a generic SOAP client for interacting with web services. SOAP, or Simple Object Access Protocol, is a messaging protocol that allows programs running on disparate operating systems to communicate using Hypertext Transfer Protocol (HTTP) and XML. This connector is versatile and can be used to interact with various SOAP services by simply configuring the WSDL URL and other options as required by the service. Use cases include automating interactions with legacy systems, integrating with third-party services that expose SOAP APIs, and consolidating various SOAP service calls through a single interface.
Prerequisites
- The WSDL URL of the SOAP service you wish to interact with.
- If the service requires HTTP Basic Authentication, you will need the username and password.
- If the service requires a client-side certificate for TLS connections, you will need the certificate in base64 format.
- Optionally, you may need to configure the transport timeout and TLS verification settings depending on your network and security requirements.
Capabilities
This connector provides the following capabilities:
- Dynamically interact with various SOAP services.
- Send custom requests to a SOAP service.
- Customize transport settings including HTTP Basic Authentication, client-side certificates, TLS verification, and transport timeout.
- Parse and handle responses from SOAP services.
Limitations
- This is a generic client; specific configurations or customizations for particular SOAP services are not provided out of the box.
Asset Setup
To set up the asset, enter the WSDL URL which is mandatory. Additionally, if your SOAP service requires authentication, provide the transport username and password.
If the service requires a client-side certificate, upload it in base64 format in the transport_certificate field.
If you need to bypass TLS verification (not recommended for production environments), set transport_bypasstsl to True.
You can also set a custom timeout for the transport connection by setting the transport_timeout field. This is an integer value representing seconds.
Notes
- Make sure that your network allows outbound HTTP/HTTPS connections to the SOAP service.
- The use of client-side certificates and the bypassing of TLS verification should be handled with caution and in accordance with your organization's security policies.
- Reference for SOAP Protocol: W3C SOAP Specification
Configurations
SOAP Authentication
SOAP authentication asset
Configuration Parameters
Parameter | Description | Type | Required |
|---|---|---|---|
wsdl | The WSDL URL to define the SOAP service. | string | Required |
transport_certificate | The transport certificate for TLS connections in base64 format. | string | Optional |
transport_username | The username for HTTP Basic Authentication. | string | Optional |
transport_password | The password for HTTP Basic Authentication. | string | Optional |
transport_bypasstsl | Whether to bypass TLS certificate verification. | boolean | Optional |
transport_timeout | The timeout for the transport connection in seconds. | integer | Optional |
Actions
Request
Makes a SOAP request
Endpoint
- Method: GET
Input
Argument Name | Type | Required | Description |
|---|---|---|---|
operation_name | string | Required | Name of the resource |
Input Example
{"operation_name":"Example Name"}
Output
Parameter | Type | Description |
|---|---|---|
response | string | Output field: response |
Output Example
{"response":"string"}
Response Headers
Header | Description | Example |
|---|---|---|
Content-Type | The media type of the resource | application/json |
Date | The date and time at which the message was originated | Thu, 01 Jan 2024 00:00:00 GMT |