This node lets you make synchronous or asynchronous requests using SOAP or REST API calls.

You can query or get information from an external system by defining a service request that includes configuring the APIs and passing the parameters.

To configure this node, set up the following:

General Settings

Click the General Settings icon and configure the following:

1. Provide a Custom Name to identify the node.
2. Select an API Type from the following options:
   1. REST: A REST API conforms to the constraints of the REST API architecture and allows interaction with RESTful web services.
   2. SOAP: A SOAP API uses the Simple Object Access Protocol (SOAP), which is a messaging protocol for interchanging data in a decentralized and distributed environment.
3. Select an Integration Type from the following options:
   1. Synchronous: The API returns resources, data, or services immediately.
   2. Asynchronous: The API returns resources, data, or services later based on the number of seconds you select. The default selection is 20s, and the available options range from 8s to 20s.
4. Configure the API request under Request Definition. Define the GET, PUT, POST, or DELETE service request, along with the API call and parameters to pass. To create a new request, click + Define Request.
   
   
5. Define your API request by following the steps outlined in Define and Test an API Request, available below.
6. Under Access Using URL Connector, select “Yes, URLs are behind a firewall and a connector has been set up” if the API has to be accessed using a URL connector that has been configured. Once this option is selected, you must set up the General Settings as explained above.
   

Define and Test an API Request

To define and test your API request, follow these steps:

• In the Request Definition section within the API node’s General Settings, click + Define Request.
• The Define Request window opens:
  
  
• Select the GET, PUT, POST, PATCH, or DELETE call from the list.
  
• Paste your API call URL in the text field and click Test.
  
• Your API call runs successfully if all the inputs provided are valid. Otherwise, an error message is displayed.
• Provide the details for the Header Key and Value pair. You can add a new pair by typing it in the empty fields. You can delete a pair by clicking the Delete (Bin) icon next to it.
  
• Click Test Request and paste the request body code in the text field. The text editor provides the following options: 
  • Format JSON data with indentation and line feeds,
  • Compact JSON data by removing white spaces,
  • Sort contents,
  • Filter, sort or transform contents,
  • Repair JSON,
  • Undo last action, 
  • Redo action.
    

• Click Save after you’ve tested the API successfully.

Actions

• Click the Actions icon and select the actions that you want the node to trigger when the API call is successful and when it fails.
• For On Success, the selected action defines how the bot handles a successful API call.
  
• For On Failure, the selected action defines how the bot handles a failed API Call.