Adding a Simphony Transaction Services API Account

Understand how to add an API account for the Simphony Transaction Services API and the configuration options.

You must have the Manage API Accounts privilege to add API accounts.

The Simphony Transaction Services API lets you create and manage checks within a revenue center.

  1. In Reporting and Analytics, click the side navigation menu, click Administration, click System, click API Accounts, and then click Add API Account.
  2. Specify account details:
    • Type - select Simphony Transaction Services.
    • Account name - enter a unique account name. Click icon of a square on top of another square to copy the value to your clipboard.

      Note:

      API accounts can't be used to sign in to Reporting and Analytics. An Invalid credentials error message is displayed.
    • Email - enter the account owner’s email address. The welcome email and password reset email are sent to this address.
    • Connection Details - displays the Enterprise Short Name, Authentication Server, and Application Server which are needed to connect to the API. The Client ID is generated when a new account is created and is also needed to connect to the API. Click icon of a square on top of another square to copy the individual values to your clipboard.
    • Add Redirect URL (Optional) - redirect URLs are part of the OAuth flow. After an application is authorized, the authorization server redirects the user to this redirect URL location. It is important to add the redirect URL so that the sensitive information included in the redirect URL only goes to the location you specify. The redirect URLs are used in:
      • Authorize endpoint - when the OAuth flow is started using the /authorize endpoint, it directs the caller to the service's authorization endpoint. Several parameters are included in the request, including a redirect URL. The server validates this redirect URL to confirm that it is a URL added as a redirect URL for this account.

      • Token endpoint – the request to the /token endpoint includes a redirect URL and the authorization code.

      Click Add Redirect URL, enter the URL, and then click Add.

    • Location Authorization Scope - select an authorization scope as follows:

      • Select All to grant the API account access to the entire enterprise, including all levels and locations.

      • Select Selected and then click Choose Locations to grant the API account access to specific levels or locations.

        • Click Hierarchy to grant access to an entire level of locations.

        • Click Locations to grant access to individual locations.

    • Client Scope - select an API scope as follows:

      • BOTH: both location and cloud-based APIs.

      • LOCAL: location-based APIs.

      • CLOUD: cloud-based APIs.

  3. Click Add.

  4. A unique Client ID value is generated for the API account. Use the ID to authenticate the API account before making API calls. You can retrieve an ID for an account by searching for the account on the API Accounts page and then clicking the account.

    The owner of the API account receives a welcome email with instructions on how to set the password for the account.

    Note:

    If you need required account and connection information, click Send Details after adding the account. An email is sent to the account owner with the details.

Parent topic: API Accounts Overview