Understanding Your API URL

The API URL is the address used to call Simphony Transaction Services Gen2 API endpoints. Each request starts with a base path and then adds the endpoint path for the API resource.

Base Path

The base path for STS Gen2 API resources is:

https://{host}/api/v1

Component Description
host The STS Gen2 host for the Simphony environment.
api The API service identifier.
v1 The API version.

Example Base Path

https://zyx-stsg2.somedomain.com/api/v1

Example Request

The following Organization API path retrieves a revenue center for a location:

  • {basePath}/organizations/{orgShortName}/locations/{locRef}/revenueCenters/{rvcRef}

Example resolved request:

  • https://zyx-stsg2.somedomain.com/api/v1/organizations/tfoinc/locations/fdmnh144/revenueCenters/42

Finding the Services URL in EMC

  1. Select the Enterprise.
  2. Click the Setup tab.
  3. Click Enterprise Parameters.
  4. Open the Applications tab.
  5. Locate the Simphony Transaction Services (Gen2) Services URL field.

Note:

Use the Services URL provided in the EMC as the environment-specific service URL. Confirm whether the displayed value already includes the API path before appending /api/v1.