When a user requests for API consumption that triggers an approval, CentraSite initiates an approval workflow and submits the user’s request to the designated group of approvers. Approvers receive the approval request in their Inbox in CentraSite Business user interface. Approvers whose user account includes a valid e-mail address also receive an email message informing them that a request is awaiting their approval.
CentraSite communicate information to users using email. This facility will not function properly until you configure CentraSite's email settings. These settings specify the Simple Mail Transport Protocol (SMTP) server that CentraSite is to use for sending outgoing email messages. For information, see the section Configuring the Email Server Settings in the document Basic Operations.
CentraSite does not generate the user’s requested API key until it obtains the necessary approvals. If an approver rejects the request, CentraSite notifies the requestor and an API key is not generated.
Approvers use the API details page to review and authorize API key requests that are waiting for your approval.
Points to consider when approving or rejecting an API key request for consumption:
If the user who requests an API key is also an authorized approver for the requested operation, the request is auto-approved. (In other words, the requestor's approval is granted implicitly.)
If the API provider has chosen for "Anyone" approval mode, only one user in the group is required to approve or reject the request. This is the default mode.
If the API provider has chosen for "All" approval mode, the request must be approved by all users in the approver group (it does not matter in which order the approvals are obtained). A rejection by any approver in the group will cause the request to be rejected.
If you are an approver, CentraSite places approve requests (i.e., any API key request whose approver group included you as a member) in the API details page for you to review and authorize API key requests.
Use the following procedure to review and approve the API key requests that are waiting for your approval.
To view and approve an API key request
In CentraSite Business UI, display the details page of the API whose API key request you want to review and approve.
You will see the pending approval requests () for an API key in
the description area of the Basic Information profile, for
example, "
N number of pending approvals
”.
If there are no pending approval requests for the API, this is
displayed as “0
".
Click the hyperlinked number (“N
”) to
open the Pending Approval Requests dialog. This dialog
contains a list of all API key requests that have been submitted for the
particular API, including requests that were auto-approved.
Choose the API key request that you want to review and approve by clicking its hyperlinked name.
The details for the request will appear in the API Key Request dialog.
In the Comment text box, type a comment. (e.g., "Request rejected. Add required specifications to this asset and resubmit".)
Click the
or button as appropriate to approve or reject the request.