REST Service Integration Overview
  • 17 Jun 2022
  • 3 Minutes to read
  • Dark
    Light

REST Service Integration Overview

  • Dark
    Light

The REST Service integration holds configuration data that is shared between REST Service methods in the REST Service such as the base URL, authentication, and any custom headers. Each REST method is an HTTP call that can be made to obtain or send data. 


Creating a REST Service

  1. Navigate to System > Integrations > External Services.
  2. Click ADD REST SERVICE in the top action bar.

  3. After entering a REST Service URL, the Ping Result field will show the result of trying to reach that URL.
  4. Braces can be used to define variables within the URL. 
  5. These variables will appear as Flow step inputs.

Show Advanced Options:
Additional HTTP Headers: Any headers set here will be applied to all REST Methods for this REST Service unless overridden in the REST Method.
Authentication: (See Authentication section)
Navigate to its Folder (this happens automatically when the REST Service is created) and add REST Methods to it.



Variables

Variables can be defined as part of the URL in a REST Service or REST Method, as well as in the request body. These variables will appear as inputs to the REST Method Flow step, and those input values will automatically be inserted in the appropriate locations when the step runs.

To include a variable in a URL or request body, put the variable name inside curly braces, with no spaces (i.e, {myNewInput})

Variable definitions won't interfere with JSON in the request body because the variable name must appear with no spaces or other special characters. For example, this request body defines 2 variables (company name and count) and includes them inside the JSON: { "name":"{companyName}", "count": {count} }

Variables that are included in the request body or as part of the URL will be URL encoded. However, values added to the REST method's URL path relative to the base section will not be encoded. For more information on creating a REST method, please visit Creating a REST Method.

Authentication Settings

After setting the necessary variables. Set the Authentication method for accessing the REST Service . The Authentication settings on the REST Service can also be overridden on each REST Method.

Basic Authentication

Setting NameDescription
Pre-Authenticate RequestIncludes credentials in the request header.
Use Static CredentialsChoose user and password here, rather than in the Flow.

The user account that this will use is the account running Decisions Server and not the user account executing the step. This is the account Properties services dialog window under Log on as.


Windows Auth

Uses the Windows environment for authentication.

Use OAuth

From the Authentication settings, toggling Use OAuth Settings triggers the appearance of the OAuth panel below.

Setting NameDescription
Use Custom Tag in Auth Header (OAuth is Default)Allows the user to input a custom OAuth header tag
Use Static OAuth TokenProvides the user with a dropdown menu that allows the user to select a pre-made OAuth Token. Without this enabled, the Token will be available as the Input.
Direct OAuth1 Signed RequestUse OAuth1 to send a direct request signed with a private certificate. Provides the Consumer Key, Initial Token Data, PFX Filename, and PFX Password Input boxes. Consumer Key and PFX Filename are required for this option.


It is advised NOT to use a Static OAuth Token; this is because the REST Service is not deployable by the OAuth Token. If a Token is set as Static, the user will have to update the REST Service to point to Tokens on a new system, when deploying to a new Server.

Ignore Server Certificate Errors 

Ignores certificate errors produced by the server when authenticating

Enable Mutual Authentication 

Enables users to upload SSL credentials such as a P12/PFC Certificate and the P12/PFK Password.


Defining Headers in REST Service Using Advanced Options

To help with such errors as Proxy Authentication Errors, provide additional information, or if additional Authentication that cannot be fulfilled by the Authentication settings is required, users may add Custom Headers to their REST Service to pass in that information.

  1. Under System > Integrations > External Services
  2. Right-click the desired REST Service and select Edit Service.
  3. From the Edit Service window, under SERVICE DEFINITION, check the Show Advanced Options box. 
  4. Under SERVICE DEFINITION [ADVANCED] > Additional HTTP Headers, click ADD. 
  5. From the Add Additional HTTP Headers window, provide the Header Key and the Flow Step Variable Name, then click OK.
    Note on Additional Header Settings 
    The Header Key represents the name of the Header being passed into the call.

    The Flow Step Variable Name represents the Data Name that will be used as the step's input in the Flow Designer. 

    Further on Additional Header Settings
    To find any Headers that may be required for the Integration via Flow, utilize API testing software such as Postman, and create a call using the Integration URL for the REST Service.

    Upon pasting in the URL, the Headers tab will populate with any Headers related to the REST Service.
  6. After all desired edits have been made, click SAVE INTEGRATION. 

For further information on Integrations, visit the Decisions Forum.

Was this article helpful?