Software AG Products 10.5 | Administering API Portal | Configuring API Portal | Configuration Settings
 
Configuration Settings
You can configure the configuration settings tenant-wide from this page. The various configuration parameters are described in the following table.
Parameter
Description
Example for values
Automatic Registration for LDAP users
Defines the LDAP user registration settings.
selected (default)
Delete user registration requests once the approval process is complete
Defines whether a user registration request is deleted, when the approval process is completed.
If this setting is not selected the user registration request is not deleted after it is approved.
selected (default)
Enable third party approval
Enables external third-party approval for the users onboarded in API Portal. If this setting is selected, then an event is generated in the third-party application when an user registration is approved from API Portal. Administrators can use the generated event to approve the user registration.
cleared (default)
Time To Live (in minutes) for the activation link in minutes
Defines the time interval in minutes for which the email activation link remains active.
30 (default)
Subject of the e-mail sent to the administrator to inform about a failed user request
Subject of the email that is sent to the administrator in case of a failed user request.
API Portal failure :[@request]
Message of the e-mail sent to the administrator to inform about a failed user request
Text that is sent to the administrator in case of a failed user request.
Hello @recipient.name, A request from user (@requestor.name) could not be processed. The details of the request are as follows - API Portal: @loadbalancer.url/#@tenant/home - Tenant: @tenant - Requesting user: @user - Request: @details - Time stamp: @timeStamp - Further details: @reason Best Regards, API Portal Team*** This notification was sent automatically. Do not reply to this email.***
Subject of the email sent to consumers to inform about a failed user request
Subject of the email that is sent to the consumer in case of a failed user request.
Request could not be processed :[@request]
Message of the e-mail sent to consumers to inform about a failed user request
Text that is sent to the consumer in case of a failed user request.
Hello @recipient.name, Your request could not be processed. The details of the request are as follows - API Portal: @loadbalancer.url/#@tenant/home - Request: @request - Time stamp: @timeStamp Try again after some time.Best Regards, API Portal Team*** This notification was sent automatically. Do not reply to this email.***
Enable analytics for global, user, and API audit
Defines, whether collection of analytics should be enabled for global, user and API audit data.
Selected (default)
Enable 'Audit' function for requesting access tokens
Defines, whether auditing should be enabled for an access token request. A log entry is generated when this is selected.
Selected (default)
Enable 'Audit' function for renewing access tokens
Defines, whether auditing should be enabled for an access token renewal. A log entry is generated when this is selected.
Selected (default)
Enable 'Audit' function for revoking access tokens
Defines, whether auditing should be enabled for an access token revoke. A log entry is generated when this is selected.
Selected (default)
Enable 'Audit' function for publishing/creating APIs
Defines, whether auditing should be enabled for APIs being published. A log entry is generated when this is selected.
Selected (default)
Enable 'Audit' function for republishing/updating APIs
Defines, whether auditing should be enabled for APIs being republished. A log entry is generated when this is selected.
Selected (default)
Enable 'Audit' function for unpublishing/deleting APIs
Defines, whether auditing should be enabled for APIs being deleted. A log entry is generated when this is selected.
Selected (default)
Enable 'Audit' function for purging logs
Defines, whether auditing should be enabled while purging the logs. A log entry is generated when this is selected.
Selected (default)
Subject of the e-mail generated when events occur in API Portal
Subject of the e-mail that is sent for events generated inside portal.
New ${event.type}!!
Message of the e-mail generated when events occur in API Portal
Text of the email that is sent for events generated inside portal.
Hello,
There is a new ${event.type} event received from webMethods API Portal (${event.portalURL}). Details of the caller as follows:
firstname: ${event.executor.firstname}
lastname: ${event.executor.lastname}
id: ${event.executor.id}
email: ${event.executor.email}
Details of the event context as follows: contextual object ref: ${event.source.id} contextual object external ref: ${event.source.externalref}
Details of the other context info as follows: <#list event.contextdata?keys as prop> ${prop} = ${event.contextdata[prop]} </#list>
Best Regards,
API Portal Team
*** This notification was sent automatically. Do not reply to this email.***
Notify consumers of access token generation
Specifies whether the consumer should be notified when an access token is generated.
Not selected (default)
Subject of the e-mail sent to consumers to inform about access token generation
Subject of the email that is sent to the consumer when access token is generated.
Access token '@applicationName' generated
Message of the e-mail sent to consumers to inform about access token generation
Text of the email that is sent to the consumers when access token is generated.
Hello @recipient.name,
Your request for an access token has been processed. The details of the token is as follows
Application name: @applicationName
Application description: @applicationDesc
APIs: @apis
API Key
API access key: @apiKeyString
Expiry date: @APIKey.expiryDate
OAuth2 Credentials
Client ID: @clientId
Client secret: @clientSecret
Best Regards,
API Portal Team
*** This notification was sent automatically. Do not reply to this email.***
Subject of the e-mail sent to consumers to inform about shared application
Subject of the email that is sent to the consumers when an application is shared with them.
@app.name is shared
Template of the e-mail sent to consumers to inform about shared application
Text of the email that is sent to the consumers when an application is shared with them.
Hello @recipient.name,
@requestor.name has shared the @app.name application with you!
Please log on to API Portal to view its details by clicking:
@loadbalancer.url/#@tenant.id/applications.
Best regards,
API Portal Team
*** This notification was sent automatically. Do not reply to this email.***
Subject of the e-mail sent to consumers to inform about unshared application
Subject of the email that is sent to the consumers when the access to a shared application is revoked.
Access to @app.name is revoked
Template of the e-mail sent to consumers to inform about unshared application
Text of the email that is sent to the consumers when the access to a shared application is revoked.
Hello @recipient.name,
@requestor.name has revoked your access to the "@app.name" application.
Best Regards,
API Portal Team
*** This notification was sent automatically. Do not reply to this email.***
Relative endpoint to be notified when new events occur
Defines the relative endpoints for notifying events
Blank (default)
Example: /apimgmt/events
HTTP method to be used to notify events
Defines the HTTP method for notifying events
Blank (default)
Example: POST
Payload to be used to notify events
Defines the payload for notifying events
Blank (default)
Example schema:
{
"firstname" :
"{executor.firstname}",
"name" : "{executor.name}",
"lastname" : "{executor.lastname}",
"email" : "{executor.email}",
"type" : "{type}"
}
Content type to be used to notify events
Defines the content type required for notifying events
Blank (default)
Example: application/json
Plug-ins enabled for publication of external events
Defines the plugins enabled for publishing external events
SMTP (default)
My application usage report template
Template of the email that is being used to generate application usage report
Example for values:
<html>
<body>
Hello @recipient.name, <br>
<h3>Your Application usage summary
for the portal instance
</h3> @loadbalancer.url/#@tenant.id/
<p>Please find the summary of
your application usage in
the below table</p>

<#assign table = "background:#FFF;">
<#assign table_th = "font-size:16px;
font-weight:400;
color:#fff;text-align:left;
padding:20px;
background-color:#0899CC;">
<#assign table_tr_td =
"font-weight:400;
color:#5f6062;font-size:13px;
padding:20px 20px 20px 20px;
border-bottom:1px solid #e0e0e0;">
<#assign align_center =
"text-align:center;">
<table style="${table}">
<thead style="border-radius(5px);">
<tr>
<th style="${table_th}">Name</th>
<th style="${table_th}">Usage</th>
</tr>
</thead>
<tbody>
<#list response as app>
<tr>
<td style="${table_tr_td}">
${app.name}</td>
<td style="${table_tr_td}
${align_center}">
${app.usage}</td>
</tr>
</#list>
</tbody>
</table>
<br>
<h3>Your Application usage detail</h3>
<#list response as app>
<p>Please find the detailed usage
of application
: <b>${app.name}</b></p>
<table>
<thead>
<tr>
<th style="${table_th}">
#</th>
<th style="${table_th}">
Date</th>
<th style="${table_th}">
API</th>
<th style="${table_th}">
Resource</th>
<th style="${table_th}
${align_center}">Usage
</th>
</tr>
</thead>
<tbody>
<#list app.details as detail>
<tr>
<td style="${table_tr_td}">
${detail?counter}</td>
<td style="${table_tr_td}">
${detail.key}</td>
<td style="${table_tr_td}">
${detail.api}</td>
<td style="${table_tr_td}">
${detail.resource}</td>
<td style="${table_tr_td}">
${detail.count}</td>
</tr>
</#list>
</tbody>
</table>
<br>
</#list>
Best Regards,<br>
API Portal Team
<br>
*** This notification was
sent automatically.
Do not reply to this email.***
</body>
</html>
API consumption request approver group
Defines which user group is allowed to decide about an API consumption.
API Consumption Approvers
Ignore API Runtime events if API is not available
Ignores the runtime events for an API if that API is not present.
selected (default)
Ignore API Runtime events if application is not available
Ignores the runtime events for an application if that application is not present.
not selected (default)
Expiration days for events
Defines the time after which the logged events expire.
30d (default)
Expiration days for analytics data
Defines the time after which the analytics data expire.
45d (default)
File formats of supported documents
Defines the supporting documents and file formats that can be attached or uploaded.
.pdf,.doc,.zip,.jpg,
.jpeg,.docx,.xls,.xlsx,.png,
.ppt,.pptx
Maximum file size (in MB) of supported documents
Specifies the maximum file size for the supporting document or file that can be attached or uploaded.
2 MB (default)
API response attachment types
Specifies the types of API response attachments that are supported by API Portal.
application/octet-stream, application/vnd.mspowerpoint, application/pdf, image/gif, image/png, image/jpeg, image/bmp, image/webp, audio/midi, audio/mpeg, audio/webm, audio/ogg, audio/wav, video/webm, video/ogg
Host names allowed for tryout
Specifies the host name that can be used in Try API section. You can use the host names specified in this field only. If no host name is specified here, you can try an API using any host name.
Blank (default)
Maximum API response payload size for tryout (in KB)
Specifies the maximum size, in KB, of response messages returned by Try API page.
512 KB (default)