An Application Programming Interface (API) key is generated by the CentraSite to identify the API, its provider, or its consumer.
The API key acts as both a unique identifier and a secret token for authentication, and will generally have a set of access rights on the API associated with it.
When configuring the API key settings, keep the following points in mind:
If you are a registered user and accessing CentraSite using the logon credentials, to configure the key settings of an API, you must have Modify permission on the API. If your user account belongs to a role that has either the "Manage Assets", "Create Assets" or "Modify Assets" permission for an organization, you automatically have permission to configure the key settings of all APIs in that organization.
If you are a registered user and accessing CentraSite as a guest, to configure the key settings of an API, you must at least have the instance-level Modify permission on the API.
This action is not visible for the following conditions:
Unless you have a minimum of "Modify" permission on the API.
If the API does not belong to the type "Service".
Use the following procedure to configure the key settings for an API.
To configure your API key settings
In CentraSite Business UI, display the details page for the API whose key settings you want to configure. For procedures, see the section Viewing Details of an API.
On the API detail page, click ). This opens the API Key Settings
dialog.
Enable the Activate Key Check checkbox to activate the key generator for this API. The generated API key can be used in each further request until it expires or is revoked by the API Provider.
But, if you choose to disable this checkbox for an API, the generated API key is available for an unlimited usage. CentraSite automatically disables the other expiration and approval options.
By default, this checkbox is enabled.
In the Expiration Interval field, type the time period that an API key can remain active until it reaches its expiry date.
Type the time period in the following format: years (y) weeks (w) days (d) hours (h) minutes (m). For example, 1y 4w 3d 5h 30m expires the API key after 1 year, 4 weeks, 3 days, 5 hours, and 30 minutes of activity.
Enable the Require Approval checkbox to initiate an approval workflow for activating the API key.
When the API has an approval workflow associated with the activation of the API key, CentraSite will not activate the API key generator until the required approvals are obtained.
By default, the Require Approval checkbox is enabled for APIs. However, if you choose to disable this checkbox for an API, CentraSite automatically displays the consumer notification options. If so, skip to step e. For more information about approval workflow, see the CentraSite online documentation section Using Approval Policies in the document Working with Design/Change-Time Policies.
If you choose to initiate an approval workflow to activate the API key generator, specify the following:
Field | Description | |
---|---|---|
Approval Workflow | All | The request must be approved by all users specified in Approver Group. (It does not matter in which order the approvals are issued.) A single rejection will cause the request to be rejected. |
Any | Default. The request can be approved or rejected by any single user in Approver Group. In this mode, only one user from the set of authorized approvers is required to approve or reject the request. | |
Approver Group | Specify the approver group. You can specify multiple approver groups. | |
Email Notifications | Subject | The text that will appear on the subject line of the email. |
Template | The template that will be used to generate the
body of the email message to the approvers in the Approver Group.
For information about using email templates, see the section Specify Email Templates for Workflow Notifications. To specify another template, use the plus button to add additional rows. Important: |
|
Action | Specify the approval action.
|
Or:
Alternatively, if you choose not to initiate an approval workflow to
activate the API key generator, specify the following:
Field | Description | |
---|---|---|
Notify Consumer via Email | Subject | The text that will appear on the subject line of the email. |
Template | The template that will be used to generate the
body of the email message to the approvers in the Approver Group.
For information about using email templates, see the section Specify Email Templates for Workflow Notifications. To specify another template, use the plus button to add additional rows. Important: |
Click the
button.Or:
Else, if at any time you wish to terminate this operation, just click
the button.