Transaction Services API Account

GloriaFood requires a Transaction Services API Account to connect with either Simphony Essentials or Simphony. Follow these steps to configure the API Account.

  1. Log in to Reporting and Analytics.
  2. Select Administration from the left navigation menu.
  3. Select System.
  4. If you do not see an area labeled API Accounts, select Roles and complete Steps 6-10; otherwise proceed to Step 11.
  5. Select a role to grant the permissions to (typically IT Manager and/or Owner).
  6. Click the Privileges tab.
  7. Search for Manage Simphony Transaction Services.
    • If you see it in Available Privileges, use the > button to move it to Selected, and then click Save.

    • If you see it in Selected, no actions are required.

  8. Close the dialog.
  9. Click Save and Close.
  10. Click System.
  11. Click API Accounts, and then click Add API Account.
  12. Specify account information as described in the following table.

    Table 3-4 API Account Information

    Field Description

    Type

    Select Simphony Transaction Services.

    Location Authorization Scope

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

    Select Selected and then click Edit to grant the API account access to selected locations.

    Username

    Enter GLORIAFOOD.

    Email

    Enter a valid email address of someone to receive a link to finish the account creation.

    Client Scope

    Select BOTH.

    Figure 3-3 Add API Account Dialog


    This figure shows the Add API Account dialog in Reporting and Analytics.
  13. Click Add. The API Accounts dialog appears.

    Figure 3-4 API Accounts Dialog


    This figure shows the API Accounts dialog in Reporting and Analytics.
  14. Copy the Client ID using the Copy link, as shown in the following figure. Paste this value in a text editor or record this value in Simphony Configuration Values. (It is necessary to insert the Client ID into GloriaFood later in Step 1 of GloriaFood Configuration.)

    Figure 3-5 Client ID


    This figure shows the Client ID field in Reporting and Analytics.
  15. You will receive an email requesting that you set your API account password. In the email, click the link to configure the password for the API account.

    The Username and Password for this account will be used in the Connect to Simphony Gloriafood dialog box in Step 1 of GloriaFood Configuration.