Configuring a REST connection

On the Connection page of the New REST Integration wizard, you can configure the connection of your system with the external REST service.

1. In the System details section, enter the name of the source system in the Name field. This field represents the name of the system that hosts the external REST service.

   For example, if the external REST service is a weather service such as Google Weather API, you can enter Google Weather in this field.

2. Enter the endpoint URL of the external REST service.
The system analyzes this URL and suggests the elements of the URL that represent resource path parameters and query string parameters.

For example, if you enter a URL in the format https//sampleURL.com/res_path1/res_path2?URLkey={URLkey}, res_path1 and res_path2 are resource path parameters and URLkey is a query string parameter;{URLkey} represents the value of URLkey that is substituted at run time.

Note: The system removes the query string parameters in the Endpoint URL field. In this example, the URL is updated to https//sampleURL.com/res_path1/res_path2 and URLkey is displayed in the Query string parameters section.

3. Optional: Update the suggested resource path names and add more by clicking Add component. Select the Parameter check box next to each resource path name that is a parameter. The system updates the endpoint URL accordingly.

   If you mark a resource path name as a parameter, the system generates a property as part of the request data model and substitutes the property's value for the value of the parameter at run time.

The parameter is displayed in curly braces in the endpoint URL.

In the example in step 2, if you mark res_path1 as a parameter, it is displayed as {res_path1} in the endpoint URL.

4. Optional: Update the suggested query string parameters and add more by clicking Add parameter.

Note: The system considers query string parameters as part of the request and creates properties for them.

5. Optional: Add custom headers for the external REST service by clicking Add header.

The system adds each request header to the REST connector rule that is generated for the methods that you select on the Resource methods page of the wizard. The value for each header is the value that you specify in the first sample that you collect on the Data model page of the wizard.

Optional: Configure the authentication for the data source that is created from your REST integration.

1. Click Add authentication.

2. Specify or create an authentication profile by selecting one of the following options:

   • Select Use Existing to choose an existing authentication profile and enter the profile name.
   • Select Define New to create a new authentication profile and select an authentication scheme:
     • Basic authentication scheme: Enter the user name and specify a password by clicking Set Password. Enter the realm and host name. Enable preemptive authentication by selecting the check box if the external service requires preemptive authentication.
     • NTLM authentication scheme: Enter the user name and specify a password by clicking Set Password. Enter the domain and host name.
     • OAuth 2.0 authentication scheme: Create an OAuth 2.0 authentication profile by following the steps that you use to complete the OAuth 2.0 tab of an Authentication Profile data instance. Create an OAuth 2.0 provider if needed.

     The Revoke access tokens button is not visible on this page. Instead, you can use the Disconnect button as explained below.

     If you select Authorization code in the Grant type list, click Connect to generate an access token. This action authenticates and authorizes your connection with the OAuth 2.0 service provider and allows you to access protected content. Click Disconnect to revoke the access token.

6. Click Next.

Open topic with navigation