Location-Based API Requirements for Simphony Transaction Services Gen 2

There are several key location-based API requirements for properties using Simphony Transaction Services Generation 2 (STS Gen 2). They are as follows:

• The on-premises implementation of STS Gen 2 requires tokens acquired from Enterprise Back Office’s (EBO) Open ID Connect (IDM). When creating API accounts for STS Gen 2 in EBO API Account Management, set the Client Scope to either Both or Local. This allows for tokens acquired for that client to be authorized to use the on-premises API. Additionally, on-premises components require initial access to the EBO IDM endpoints in order to acquire authentication related details for workstations running the on-premises API. See the Reporting and Analytics User Guide, specifically the Simphony Transaction Services API topic in Chapter 5, for more information.

• Since HTTPS is a prerequisite for using the on-premises API, ensure that a valid root certification authority backed TLS certificate is loaded onto all workstations using the on-premises API.

• The default port for the on-premises API is 5443. API paths after the base URL are the same as the cloud endpoints, so cloud documentation can be used if necessary. The API path looks similar to the following example – https://onprem.example.net:5443/api/v1/sample/ABC/locations/biz1.