Configuring Approvals for Subscribing Package
You have to configure the approval settings in API Gateway, to enforce approval for subscribing a package to a plan in API Portal.
To configure approvals for subscribing a package
1. Expand the menu options icon , in the title bar, and select Administration. 2. Select General > Approval configuration > Subscribe package.
3. Set the Enable toggle button to the on position to enable approval configuration to take effect.
4. Select the team of approvers from the Approvers drop-down list.
5. Select Anyone from the Approved by drop-down list.
This implies that, any one user associated with the team can approve or reject the requests. The requester need not wait for the approval of each approver in the approvers group.
Note:
If a user is associated with the selected team, then the user can approve or reject a pending request even if the user is not associated with the Approvers group.
6. Select Configure approval initiate request mail template to be sent to approver.
This is to configure the email template to be sent to the approver for subscribing a package.
7. Provide the following information in the Configure approval initiate request mail template to be sent to approve section:
Field | Description |
Send notification | To send an email notification to the approver to approve the request for subscribing a package. |
Subject | The subject line of the email to be sent. |
Content | By default, the template appears. You can customize the email content. Note: The @ character acts as a place holder and the values are automatically generated by the system. For example, Hello @approver.name appears as Hello Joe in the email sent, where Joe is the approvers login ID. |
Note:
The email notifications are sent only to the local API Gateway users.
8. Select Configure request approved mail template to be sent to requester.
This is to configure the email template to be sent to the requester to notify that the request for subscribing a package is approved.
9. Provide the following information in the Configure request approved mail template to be sent to requester section:
Field | Description |
Send notification | To send an email notification to the requester that the request for subscribing a package is approved by the approver. |
Subject | The subject line of the email to be sent. |
Content | By default, the template appears. You can customize the email content. Note: The @ character acts as a place holder and the values are automatically generated by the system. For example, Approval of @event.type appears as Approval of Subscribe Package in the email sent, where Subscribe Package is the event.type. |
10. Select Configure rejection mail template to be sent to requester.
This is to configure the email template to be sent to the requester to notify that the request for subscribing a package is rejected.
11. Provide the following information in the Configure rejection mail template to be sent to requester section:
Field | Description |
Send notification | To send an email notification to the requester that the request for registering an application is rejected by the approver. |
Subject | The subject line of the email to be sent. |
Content | By default, the template appears. You can customize the email content. Note: The @ character acts as a place holder and the values are automatically generated by the system. For example, Approval of @event.type appears as Approval of Subscribe Package in the email sent, where Subscribe Package is the event.type. |
12. Click Cancel to revert to the last saved changes or to abandon all the changes if the values are not saved.
13. Click Save.