Create and Manage Inbound SOAP Web Services in Qntrl | Inbound SOAP Web Services | Qntrl Online Help

Configure Inbound SOAP Web Service

Inbound SOAP Web Services allow you to create endpoints that external systems can call to interact with your Qntrl instance. When a SOAP request is sent from an external system, Qntrl processes the request and sends back a response based on predefined operations. To define and structure these SOAP-based interactions, WSDL (Web Services Description Language) contracts are used which describes the available operations, the expected request parameters, and the format of the response.
For detailed information on WSDL contracts and how to configure them, please refer to the section on WSDL.

Example:  
A third-party system sends a SOAP request to your Qntrl instance to retrieve customer details. Qntrl processes this request and sends the customer details as an XML response.  

Creating an Inbound SOAP Web Service   

To create an inbound SOAP web service in Qntrl:

1. Navigate to(settings)  >> WEB SERVICES >> Inbound >> Select SOAP
2. Define the service  :
  • Name: Provide a unique name for the SOAP service.
  • Source Endpoint: The endpoint URL that will be used to interact with your SOAP service.
  • Operation: The operation the service will perform. Default: execute.
  • Resource: Choose an existing function or create a new one to define the actions for the SOAP service. Only SOAP-type functions will be shown in the list. If you create a new function, write the script in the editor. The function will automatically appear in the function module with a generated name, which you can change later.
  • Authentication Type: Choose the authentication type for the API call. Qntrl supports three authentication types:
    • OAuth
    • API Key
    • Basic Authentication (username and password encoded in Base64 and sent in headers).
  • Mandate WSDL Compliance: Select the option to enable WSDL compliance.
    • True

      • Only the configured request and response parameters are allowed. Any extra parameters in the incoming request will be rejected.

      • Non-configured output parameters will be excluded from the response.

      • The operation name in the request must exactly match the one defined in the WSDL — otherwise, the request will fail.

    • False

      • The system accepts any external request, even if it contains parameters not defined in the WSDL.

      • However, it still applies validation rules to the parameters you have configured.

  • Request Params: Define the parameters to be passed in the request.
    • Param Name: Define the name of the input parameter.
    • Type: Select the data type.
    • Allowed Regex: Set restrictions for the parameter values.
    • Min Length: Define the minimum length of the input.
    • Max Length: Define the maximum length of the input.
    • Default Value: Set default values for parameters.
    • Mandatory: Specify whether the parameter is mandatory. If a mandatory parameter is missing, an error will occur.
  • Response Params  
    • Name: Define the name of the output parameter.
    • Mandatory: Set whether this parameter is required in the response.
Notes
Validation ensures incoming requests meet the expected format. If validation fails, the request will be rejected.

      

Qntrl automatically generates the WSDL based on the endpoint URL, operation name, and the configured request/response parameters. Any changes made to these configurations will automatically update the WSDL.

To download the WSDL, send a GET request to the endpoint URL using the selected authentication method.

      

 

Processing Requests and Responses 

The Editor provides a flexible environment to process both SOAP requests and responses, and to handle errors efficiently using CodeX SDK's.

Handling SOAP Requests
  • Use the soapRequest object to process incoming requests based on the configured parameters and operations.
Managing SOAP Responses
  • The soapResponse object allows you to customize the response, setting the required output parameters based on the request.
 Handling Errors
  • In case of an error, use the setFault method to define error codes and messages, which will be communicated back to the client.
 

Calling and Processing WSDL in Qntrl   

How to make a SOAP WSDL Request

Method: Any HTTP method (e.g., GET)

URL: https://core.qntrl.com/webservice/soap/<org-id>/<source_endpoint>?WSDL

Authentication (must be added in the request header):

  • OAuth Token
    • Header Format: Authorization: Zoho-oauthtoken <access_token>
    • Required OAuth Scopes: ws_soapinbound.UPDATE
  • API Key  
    • Header Format: Authorization: Bearer <api_key>
  • Basic Authentication
    • Authorization: Basic <base64-encoded username:password>
You need to append ?wsdl to the service URL. The WSDL defines the operations and message structure for the service.This will return the WSDL for the specified API, which external systems can use to interact with the service.

How to Send a SOAP Message Request  

Method: Any HTTP method (e.g., POST)

URL: https://core.qntrl.com/webservice/soap/<org-id>/<source_endpoint>

Authentication (must be added in the request header):

  • OAuth Token

    • Header Format: Authorization: Zoho-oauthtoken <access_token>

    • Required OAuth Scopes: ws_soapinbound.UPDATE

  • API Key  

    • Header Format: Authorization: Bearer <api_key>

  • Basic Authentication

    • Authorization: Basic <base64-encoded username:password>

Body: The body should contain the raw XML request data.

 


Sample SOAP Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ord="https://98173384.core.localqntrlhost.com/webservice/98173384/orderManagement"> <soapenv:Header> <ord:AuthHeader> <ord:companyName>Zoho Corp</ord:companyName> </ord:AuthHeader> </soapenv:Header> <soapenv:Body> <ord:PlaceOrder> <ord:OrderID>12345</ord:OrderID> <ord:CustomerID>98765</ord:CustomerID> <ord:ProductID>10111</ord:ProductID> <ord:Quantity>3</ord:Quantity> <ord:OrderDate>2025-03-28</ord:OrderDate> </ord:PlaceOrder> </soapenv:Body> </soapenv:Envelope>


Other Actions

Enable or Disable a SOAP Request

You can control the activation of individual SOAP requests from the configuration panel:

  1. Navigate to(settings)  >> WEB SERVICES >> Inbound >> Select SOAP

  2. Under the Resources section on the left panel, locate the SOAP message.

  3. Use the toggle button next to the message name to enable or disable it.


Delete a SOAP Request

To remove a SOAP request:

  1. Navigate to(settings)  >> WEB SERVICES >> Inbound >> Select SOAP

  2. Select the message you want to delete.

  3. Click the delete icon at the top right of the message details page.





    • Related Articles

    • Configure Inbound REST Web Service

      Qntrl’s Inbound REST Web Service allows you to create custom API endpoints that external users or systems can call to perform specific actions inside Qntrl. When a user triggers the API, Qntrl receives the request and processes it based on the ...
    • Configure Outbound SOAP Web Service

      Outbound SOAP services in Qntrl enable communication with external SOAP-based APIs. These services rely on WSDL (Web Services Description Language) contracts that define available operations and parameters. For more detailed information on WSDL ...
    • Configure Outbound REST Web Service

      Outbound REST Web Services enables users to interact with external web services by sending HTTP requests to retrieve, create, update, or delete data on REST-compliant servers. This functionality is designed to integrate seamlessly with external APIs ...
    • Web Services Overview

      Web services enable different applications to communicate with each other over a network using standard protocols, enabling the exchange of data and execution of remote operations. The Qntrl platform supports two types of web services: Inbound Web ...
    • Custom Module

      Early Access Custom Module is not enabled for all users. If you’d like to try it out, please email our support team for early access. The predefined modules in a Bridge may help you reach a DB/App server/AD and accomplish your tasks. However, to meet ...

    You are currently viewing the help articles of Qntrl 3.0. If you are still using our older version and require guidance with it, Click here.