CentraSite Documentation : Working with the CentraSite Business UI : API Management Solutions : Managing API Keys and OAuth 2.0 Tokens : Renewing an API Key : Configuring the Email Templates for Key Renewal
Configuring the Email Templates for Key Renewal
Notifications informing the new validity of the API key are generated and sent to both the API provider and API consumer.
There are three kinds of key renewal notifications:
*An API key renewal request is pending for approval - an information type message to the API provider.
*Your API key renewal request is approved - an information type message to the API consumer.
*Your API key renewal request is rejected - an information type message to the API consumer.
You can configure delivery of such notifications in the centrasite.xml configuration file.
To configure email templates for API key renewal
1. Use a text editor to open the custom centrasite.xml file. The configuration file is located in the <CentraSiteInstallDir>\cast\cswebapps\BusinessUI\ directory.
2. Locate the KeyRenewalSettings element in the file.
The key renewal notification settings would look like the following:
<KeyRenewalSettings>
<Approve
subject="CS_MSG_INMBU_DEFAUL_EMAIL_SUBJECT_ACCESS_KEY_RENEWAL_SUCCESS_OR_
APPROVE"
template="APIKeyRenewalSuccess.html" />
<ApprovalRequest
subject="CS_MSG_INMBU_DEFAUL_EMAIL_SUBJECT_ACCESS_KEY_RENEWAL_PENDING"
template="APIKeyRenewalPendingNotification.html" />
<Reject
subject="CS_MSG_INMBU_DEFAUL_EMAIL_SUBJECT_ACCESS_KEY_RENEWAL_REJECT"
template="RejectionNotification.html" />
</KeyRenewalSettings>
3. Uncomment the section API Key Settings to enable key renewal notifications.
4. Use the Approve property to set the subject and body of the notification message for the consumers whose API key renewal request is approved.
5. Use the ArppovalRequest property to set the subject and body of the notification message for the provider who has an API key renewal request pending for approval.
6. Use the Reject property to set the subject and body of the notification message for the consumers whose API key renewal request is rejected.
7. Save and close the file.
8. Restart Software AG Runtime.
Copyright © 2005-2016 Software AG, Darmstadt, Germany.

Product LogoContact Support   |   Community   |   Feedback