You are aware of using the REST API connectors using the different authentication methods like OAuth 2.0, API keys, and so on.You can also have some web services that use the SOAP APIs. Studio now also supports SOAP APIs.
To add SOAP APIs connector, under .Studio > Connectors, click (+) Connector
Select REST API and configure the connector fields.
Select the type of Authentication that you want to use. Here we are going to use the option None and click Continue. However, feel free to use any other authentication method which is supported by your SOAP Web Services. You need to provide the configuration parameters required by the specific API if any. Here for the sake of an example let us take the NumberConversion service from dataaccess.com web service.
Provide a GET method here and click Continue to test the configuration. You can provide the necessary Query String Parameters and Header parameters as per your web service. For this example there is no parameter needed so we are not adding them.
Once the configuration settings are done you need to Test Connection to check the connection for the endpoint. This way you would be adding the necessary parameter and testing the configuration. Under Response, you would see the response values from your respective API. When the request is successful it will show the respective message.
Click Save and the process is complete. Your API can be seen under Custom API Connectors now.
Add API to configure
Now that you have configured the API category, you now need to add the API for configuration. Under Studio > Connectors > Custom API Connectors you can see your connector is added. To add this API, click Add API.
Here we are taking the example of the API that would help convert the numbers into words. Now Add the Service Name, the Method as POST method, and the URL.
Under configuration, there are Request, Response and Preselect Query configurations which you can add depending upon your API. Note that under Authentication, you can see Type of authentication : No Authentication. For SOAP methods the Content Type will most often be text/xml.
Here you are passing a dynamic variable as input, a numeric value accepted from the user and passed to the API using a variable entered in double curly brackets.
If you check the response of this method you will notice that the response has been changed to a JSON format while the API actually returns an XML output. This would then be easily returned to the App and used in an easily readable format. The process has been simplified in the connector configuration.
Once you have configured the API as required, you can click Test and Save. You can check the response accordingly to your request. The API is now added successfully to your Custom API connectors.
Using the SOAP API
Let us add a numeric control to add Dollar in numbers, an Action button to trigger the conversion action, and a Text control to display the resulting Dollar value in words.
Now if you have a form to enter a number and want to show it in words you simply need to add an action flow task. Under Server-side actions > Custom API Connectors you can find your configured connector.
- Select the Connector and click Continue.
- Select the specific connector (the one for conversion in this example here). Add the fields which in this example is the Dollar input from the numeric control added to the form.
The Response from the API would then be fetched with a variable as shown below. It is returned as output. Envelope.Body.APIname.variable.
You can now use the value of this Response variable from this API task and set the value of the other text control using the SetControlValue task.
If you take a preview you can see the dollar value presented in Words here.