Notification-APP

Notification-APP

Notification API

 Funktionsumfang der Notification-App

Die Notification-App beinhaltet die zentrale HTTP-Schnittstelle zum Versenden von Benachrichtigungen in einer d.3ecm-Umgebung.

 Verwenden der API-Funktionen

Nachfolgend erfährst du, wie du die Programmierschnittstelle der Notification-App für eigene Entwicklungen nutzen kannst.

 Versenden von Benachrichtigungen

Um eine Benachrichtigung über die Notification-App zu versenden, muss deine App eine POST-Anfrage im JSON-Format stellen.

   
POST /notification/notificationmessage
Content-Type: application/hal+json

Repräsentation der Ressource:

   
{
    "message" : string,
    "messageHtml" : string,
    "recipients" : string[],
    "subject" : string
}

EigenschaftTypBeschreibungPflichtAnmerkung
messagestringInhalt der Nachricht als einfacher Text (Plain Text)Ja
messageHtmlstringInhalt der Nachricht im HTML-FormatNein
recipientsstring[]Liste der Empfänger der NachrichtJaUser- oder Group-IDs der IdentityProvider-App
subjectstringBetreff der NachrichtNein

Eine beispielhafte Anfrage könnte wie folgt aussehen:

   
{
    "message" : "This is a test notification",
    "messageHtml" : "<html><p>This is a <b>test notification</b></p></html>",
    "recipients" :
        [
            "4a24d9d0-f665-4b6b-abd4-5f60bab3d0c4",
            "5e23d2c4-f825-2d5e-fbd2-5a30dfb3e0d6"
        ],
    "subject" : "My subject"
}