Add a role for administering API user accounts or edit
an existing role.
When you create or edit the role, assign the API
Accounts system privilege View/Add/Edit/Delete
API Accounts to the role. For example, create a role named API User Administration.
Add a user that can administer API user accounts and assign
the user to the role you created or edited (for example, API User Administration).
Adding API User Accounts
You must have the View/Add/Edit/Delete API
Accounts privilege to add API accounts.
In Reporting and Analytics, click the side navigation menu, click Administration, click System, click API Accounts, and then click Add API Account.
Specify account details as described in the following table.
The API for which you are adding the account determines the values
that you specify.
Field
Description
Account name
Enter a unique account name.
Email
Enter the user’s email address.
Type
Select the feature that the API account will have access
to.
Client Scope, Authorization Scope
If you selected Simphony Transaction Services from the Type drop-down, specify the client
scope and authorization scope. See Simphony
Transaction Services API.
Enterprise Location or Level
If you selected Business Intelligence API, select the locations or levels for which the API returns data.
Data Access Permissions
If you selected Business Intelligence API, specify the type of data the account can access. See Business Intelligence API.
Click Add.
A unique Client ID value is generated
for the API account. Use the ID to authenticate the API account before
making API calls to the Reporting and Analytics database. You can retrieve an ID for an account by searching
for the account on the API Accounts page and then clicking the account.
The API account user receives a Welcome email with instructions
on how to set the password for the account.
To edit an account, select it from the account list and
make your changes.