Breadcrumbs

Notifications

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

The notifications can also be sent by by email. This feature must be enabled during the the setup of your Scheer PAS installation. Ask your Scheer PAS administrator for help.

Notifications are sent on the following occasions:

Occasion

Recipients

Notifications Inbox

Email

New API sign-up request for an "approval required" API

  • All members of the organization with planAdmin permission.

  • The person who requested API access.

check mark

check mark

Approval of an API sign-up request

The person who requested API access.

check mark

check mark

Rejection of an API sign-up request

The person who requested API access.

check mark

check mark

Publication of a client

All members of the organization with clientAdmin permission.

check mark

cross mark

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.

check mark

check mark

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

sidebar_notifications.png

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

api_notifications.png

The notifications are also available in the API Developer Portal:

devportal_notifications.png

In the API Developer Portal, you can select between different notification views (Unread, Read, All). Use icon devportal_ok.png 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.

Icon

Description
icon_api_info.png

Indicates an information message.
icon_api_edit.png

Indicates that the administrator has a pending task.
icon_api_check.png

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.

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

Information Messages

info_client_published.png

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

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

Click the message in the notification list...
relevant_client.png

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

Use the breadcrumb menu at the top of the page for guidance.

Task Messages

task_approval.png

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

Example: A developer requested access to a Private API.
click_task.png


Click the message in the notification list...
relevant_api.png

...  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.

Use the breadcrumb menu at the top of the page for guidance.
Related Pages: