Local Listener Web Service

Note: This section applies to the Cleo Harmony and Cleo VLTrader applications only.

A web service provides a platform-agnostic enterprise application integration (EAI) mechanism. The Cleo Harmony and Cleo VLTraderapplications offer two web services: SOAP and REST.

Local Listener Web Service SOAP reference

There are two kinds of SOAP web services offered: a general purpose web service and a service designed specifically to work with TradeLink.

Resource Path

The check box activates and deactivates access to this resource. Access is activated by default.

The default value of the path itself is /services.

General Purpose web service

Used to initiate trading partner mailbox sends and receives through any Cleo Harmony or Cleo VLTrader protocol.

Similar to the Java API IMailboxController interface, the web service provides for send, receive, and sendAndReceiveoperations. A delete operation is also included for confirming receipt of a payload file after a receive. .

Password: Required by the web service. The password is immediately operational for any configured Cleo Harmony or Cleo VLTradermailbox.; Available when you select General Purpose web service.
WSDL 1.2 compliant: Select to eliminate overloaded operations.; Available when you select General Purpose web service.
Use arrays: Indicates whether the host/mailbox should be specified in a string array rather than separate string arguments. When WSDL 1.2 compliant is not activated, Use arrays will default to activated.

TradeLink web serivce

Used to initiate trading partner mailbox sends and receives through any Cleo Harmony or Cleo VLTrader protocol.

Database Driver String
Connection String
Username
Password: Information required to connect to a TradeLink database. If you are not sure of these values, contact your TradeLink system administrator.

Allow web access to logs\ directory

Enables access to VersaLex log files from within the web service activated, whether a general purpose web service or TradeLink.

Local Listener REST Service reference

The REST web service is a lightweight alternative to SOAP.

Resource Path: Select to activate the service.; Defaults to /api. It can be changed at any time, but must start with a forward slash (/).
Access-Control-Allow-Origin Response Header: Specify domains that can access resources in the Resource Path.; For example, to restrict access to the Resource Path to requests only from http://domain.example, specify http://domain.example; Specify an asterisk (*) to allow access from any domain or a regular expression to allow access from multiple, specific domains.
Disable Basic Access Authentication for REST API Requests: Select this option to disable users from accessing the REST API using the HTTP Basic Access Authentication method. OnlyOAuth2.0 authentication is accepted.