SOAP Component

Using the SOAP component.

The SOAP component allows connecting to an existing WSDL service. This allows you to expose the service as REST API or use the component data in service flow for more advanced service logic.

SOAP Service

In the SOAP Service section you need to enter the service URL. Once you enter the URL click the Retrieve buttons. This will ask API Express to learn about the service and automatically populate the Service drop down.

Select a service from the Service list. Once a service is selected, the Port list will be populated. Select a port and then select an operation. The Operation list will also be automatically populated.

When the operation is selected the Request Body and sections will be filled the correct request body.


First time here? Try this quickstart tutorial.

Header Parameters

You can enter an optional header parameter and map it to any Components Data variables.

Request Body

This section will be automatically filled when you select an operation. Some services will expect a parameter inside the request body. You can insert any Components Data variables into the request body. Here is an example how to do that. Note that it has to be inserted as a JavaScript string.

result =
'<soapenv:Envelope xmlns:soapenv="">' +
    '<soapenv:Header/>' +
    '<soapenv:Body>' +
        '<ns:FahrenheitToCelsius xmlns:ns="" xmlns:xsi="">' +
        '<ns:Fahrenheit>' + PARAMS.QUERY.temperature + '</ns:Fahrenheit>' +
        '</ns:FahrenheitToCelsius>' +
    '</soapenv:Body>' +

In the code example above, PARAMS.QUERY.temperature is inserted as a parameter.

Response Body

This section will be automatically filled when you select an operation.


This section has a number of samples using the SOAP component:

Basic Authentication Example

When a SOAP services is secured with Basic Authentication, here is how to use it in API Express:

  1. Create an administrator user in Users collection ( database).
  2. Upload your WSDL file into the Files collection.
  3. Specify that only administrator user can have access to this file (via ACL).
  4. Use the Master Key in WSDL URL for SOAP component. The URL will look like this:<your_master_key>
  5. Add authentication header for SOAP request with username:password string in Base64 format.
  6. Header parameter name: Authorization.
  7. Header parameter value: Basic <base64_string>. For example user1:pass1 is dXNlcjE6cGFzczE= in Base64. You can use an online tool such as to create the string or use the browser console to invoke this JavaScript: window.btoa("user1:pass1");.
  8. You are now ready to test and run the service.

Video Example

This video example shows how to connect to an external SOAP service from the API Express.