Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

PAS 22.1 The Notifications menu informs you about important events in API Management and the API Developer Portal.

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameinfo_enable_mail_notifications
PageWithExcerptINTERNAL:_api_excerpts

Notifications are sent on the following occasions:

OccasionRecipientsNotifications InboxEmail
New API sign-up request for an "approval required" API
  • All members of the organization with planAdmin permission.
  • The person who requested API access.
(tick)(tick)
Approval of an API sign-up requestThe person who requested API access.(tick)(tick)
Rejection of an API sign-up requestThe person who requested API access.(tick)(tick)
Publication of a clientAll members of the organization with clientAdmin permission.(tick)(error)
API is retired
  • Every user with clientAdmin permission and an existing contract between their client and the retired API.
  • A notification will be sent for every affected contract.
(tick)(tick)


The Notifications menu is displayed directly in the sidebar of API Management. Click the menu option to open the notifications.

The number of new notifications is also displayed in the sidebar. All notifications are displayed in a list:

The notifications are also available in the API Developer Portal:

In the API Developer Portal, you can select between different notification views (Unread, Read, All). Use icon to mark a notification as read.

Functionalities of the Notification List

The notification list in API Management displays all unread messages, which makes it a task list for the administrator.

IconDescription

Indicates an information message.

Idicates that the administrator has a pending task.

Click this icon to mark the message as read. The action removes the message from the list.

The messages in the notification list are interactive: Click on a message to go to the corresponding location.

Info

Once a message is clicked, it disappears from the list of notifications.

Information Messages

Information messages inform the administrator only about an event in API Management.

Example: A new client has been published within API Management.

Click the message in the notification list...

... to open the details page of the relevant client.

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameuse_breadcrump
PageWithExcerptINTERNAL:_api_excerpts

Task Messages

Task messages inform the administrator about open requests or pending tasks.

Example: A developer requested access to a Private API.


Click the message in the notification list...

...  to open the Contracts tab on the details page of the relevant API where you find the Approve/Reject buttons to authorize the request - or to deny it.

Multiexcerpt include
SpaceWithExcerptINTERNAL
MultiExcerptNameuse_breadcrump
PageWithExcerptINTERNAL:_api_excerpts



Panel
titleOn this Page:

Table of Contents

Panel
titleRelated Pages: