Outgoing REST web services

This function is used to declare outgoing REST Web services that can be used from a SAFE X3 dedicated API.

Parameters

Name

An outgoing REST Web service is identified by a name that is mandatory and unique. It is used during the call.

Base Url

The base URL is the prefix of the call to the service. It usually only includes the beginning of a URL that can provide different services. The services URL can be given during the call.

Content type

Defines the format of the data exchanged. It can be either XML or JSON.

Authentication

Defines if an authentication is required when the service is called. The choices are None or Basic.

Parameters

This array allows you to define parameters as a list of keys ans associated values. These parameters can be overridden during the Web service call.

Headers

This array allows you to define parameters sent in the HTTP language (such as "accept" and "accept-language") with their associated values. These parameters can also be overridden during the Web service call.

CA certificates

You have to add all the CA certificates of the site to ensure a secure connection (TLS).

Operation

An operation called Test GET is available from the right-hand panel to call the Web service in GET mode. If the result status is OK (200), a blue bar is displayed with the corresponding message. If an error occurs, the corresponding HTTP code is displayed with the status description in a red bar.

See also

The ASYRRESTCLI library contains the functions used to execute outgoing REST Web services.