REST Connection

image_pdfimage_print

This connection allows, in a generic way, data retrieval from web services that apply to the REST (representational state transfer) architectural style. Such “RESTful APIs” are widely used by a variety of service providers.

The REST connection supports REST web services that

  • are based on HTTP
  • use the HTTP methods GET or POST (e.g. DELETE and PUT are out of scope)
  • return data either in JSON or XML format

The REST connection supports the SSL protocol, i.e. HTTPS URLs are allowed. No special parameters are required for its use.

Note: For returned data, only application/xml and application/json are allowed. Content types such as text/plain, text/html, image/gif and image/jpeg are not allowed.

Main Settings

Resource:

 The URL for the source data, e.g. https://abc.example.com/resource

HTTP Method:

GET

Retrieves a resource but does not modify it in any way (read only). This method is cacheable. GET requires a URL parameter (see below).

POST Creates a new subordinate resource, such as a subdirectory. This method requires a Header Parameter (see below) or Request Body (see Advanced Settings).

Header parameters:

The header parameters of the web service as parameter-value pairs. See screenshot below for an example.

URL parameters:

The URL parameters of the web service. Required for GET method. The URL parameter can be anything, as it is specific to the URL used. For example, the screenshot below shows a URL parameter to get a set of data specific to a certain location.

Advanced Settings

Authentication Method:

None No authentication method required.
Basic Basic authentication for REST requests. Requires values for user name and password for the resource
NTL NT LAN Manager (NTLM), a Microsoft security protocol in a Windows network. Requires values for user name, password, workstation, and domain for the resource.
OAuth2 client credentials The Open authorization Standard OAuth2 with client credentials used as Authorization Grant. Parameters: Key, Secret, Scope
OAuth2 password credentials The Open authorization Standard OAuth2 with password credentials used as Authorization Grant. Parameters:  Client ID, Username, Password, Scope

Request Body:

As an alternative to simple body parameters, the complete HTTP body can be specified.

SSL Mode:

verify Checks the certificate; if response is OK, the certificate is validated.
trust Imports the certificate to the keystore, if not yet available
off No SSL is used

Timeout:

The timeout of the web service request in seconds.

Note: one specific group of supported web services are those that fulfill the OData (Open Data) Protocol. For more information, see http://www.odata.org/.

image_pdfimage_print