External Services
External Services solve the business logic of a transaction by invoking third-party services via a REST or SOAP communication protocol.
The External Services page contains a list with all the external services you have created. To access this page, click Resources > External Services. Refer to the annotated image below to learn more.
Search bar. Search by name, code or type of protocol.
Create a new external service.
List of external services displayed in a table with the following columns:
Name
Name given to the transaction.
Protocol
Whether the service calls the API via a SOAP or a REST protocol.
Description
Description given to the external service.
User
User who made the last update.
Updated
Date of last update.
Actions
Click the pencil icon to edit the external service.
To create or edit external services (REST or SOAP), go to Resources > External Services. The External Services page opens, showing a table of all the services already created.
Create External Services
Based on the communication protocol the third party uses, you can invoke a REST or SOAP service. Click Create external service and then select API Rest to create a REST service or select API Soap to create a SOAP service.
You can invoke a SOAP service to use XML communication protocols. The environment interprets the configuration information that comes in a WSDL file provided by the third party. This file publishes the methods and their corresponding input and output parameters in your environment.
Notice
Contact your third-party service provider to obtain the WSDL file, and save it for later.
Follow the instructions below to create a SOAP service.
In the Service Information section, identify the service with a name and a description. The service name usually includes an ID as prefix; for example, “999-Testing SOAP”. By default, the service type is SOAP.
In the Technical Data section, upload the WSDL file. Click the upload icon that appears next to the WSDL field.
Once the file is loaded, the system completes the Endpoint and Test Endpoint fields. Check the Technical Data section to view a list of the methods and their correspoding input and output parameters. Select a method to check its parameters.
Click Save or Save service to finish.
You can invoke a REST service to use HTTP communication protocols in your environment.
Follow the instructions below to create a REST service.
In the General Information tab, enter a name and a description for the service. Click Next to continue.
In the Method tab, define the HTTP method that calls the service to receive information on your end. Add the URL (endpoint that contains the information you need to receive). Complete the Query Params with a key (name or number) and its type. Select the type (string or number) from the Type drop-down menu. If you need to call more than one query, click + Add parameters. Click Next to continue.
In the Settings tab, define the Headers and the Authorization settings of the method. By default, you have one auto-generated header with its key and value. Click + Add Headers to add more headers as needed. Click Delete (trashcan icon) to delete a header.
In the Authorization tab, you can select Bearer Token as an authorization setting.
Click Summary to continue.
The Summary popup shows an overview with the information you provided to create the service. If the summary is correct, click Confirm.
Studio displays a message confirming that the REST service was successfully created. Click Close to return to the External Services page or click Create Transaction to create a transaction that invokes the service. Read Transactions Editor to learn more.
Edit External Services
To modify the settings of any service in the External Services page, click Edit (pencil icon) in the Actions column. Refer to Create a REST Service or Create a SOAP Service to learn how to edit each field.