sapiConfig.xml for SAPI

You configure the Service API (SAPI) is in the sapiConfig.xml file.

Parameters

Section

Parameter

Type

Description

Environment

mode

String

Has to be one of

  • testing
  • development
  • staging
  • production

absoluteUrl

Boolean

Flags whether links are returned as relative or as absolute links:

  • True: absolute links
  • False: relative links

baseUrl

String

REST API root URL

Note: Only used if parameter absoluteUrl is set to true.

AutomationEngine

saraFolderPath

String

Name of REST API root folder

Default value: /SERVICES

OauthServer

validationUrl

String

OAuth validation endpoint URL

Format: <protocol>://<OAuth_serverHost>:<Port>/<Name_of_deployed_OAuth_WAR_file>/internal/oauth2/validate

Example:https://oauthsrv:8080/oauth-server/internal/oauth2/validate

Important! A protocol indication (http/https) is required.

username

String

User name for the basic authentication of the OAuth validation endpoint

Note: This must be the same user name as specified in OAuth configuration file configuration.properties for OAuth for parameter ValdidationEndpoint.Username.

password

String

Password for the basic authentication of the OAuth validation endpoint

Note: This must be the same password as specified in OAuth configuration file configuration.properties for OAuth for parameter ValdidationEndpoint.Password.

Example

<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
 
    <AutomationEngine saraFolderPath="/SERVICES" />
 
    <OAuthServer
        validationUrl="http://oauthsrv/oauth2/validate"
        username="User1"
        password="PWord" />
 
    <Environment
        mode="development"
        absoluteUrl="false"
        baseUrl="http://url_to_sapi_root" />
 
</Configuration>