5 API Accounts Overview
Connect to Simphony web services.
API accounts are required to connect to Simphony web services. The following APIs are available:
-
Business Intelligence API
-
Configuration and Content API
-
Transactions Services Generation 2 API
Generally, each API account type has the following information:
Details | Description |
---|---|
Type | Select the type of API account. Options include Simphony Transaction Services, Business Intelligence API, or Content and Configuration API. |
Status | Only active accounts can be used to connect to the API. Set an account to inactive if it is no longer used. |
Account details | This includes a unique account name and the email address of the person who is responsible for and manages the account. The welcome email and password reset emails are sent to this address. |
Connection details | Includes information that is required to authorize and authenticate the API account and make API calls. For existing accounts, you can click Send Details to receive an email that includes the account and connection details. |
Authorization scope | Depending on the API account type, choose the authorization scope for the account. For example, which locations the account is allowed to access. |
Additional options or permissions | Depending on the API account type, additional options or permissions can be configured. |
Redirect URL | (Optional) Redirect URLs are part of the OAuth flow. After an application is authorized, the authorization server sends 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. |
After adding a new account, the account owner receives a welcome email containing the relevant connection information as well as a link to set the password for the account. This is required for the initial account authentication.
Note:
In most cases, APIs require a separate cloud subscription. Contact your sales representative to learn more.- Granting Permission to Administer API Accounts
Understand role privileges required to administer API accounts. - Adding a Business Intelligence API Account
Understand how to add an API account for the Business Intelligence API and the configuration options. - Adding a Simphony Transaction Services API Account
Understand how to add an API account for the Simphony Transaction Services API and the configuration options. - Adding a Content and Configuration API Account
Understand how to add an API account for the Simphony Content and Configuration API and the configuration options. - Editing API User Accounts
Understand how to update API user accounts. - Viewing API Activity
Understand how to view API activity and the required privileges.