Push-Benachrichtigungen

Funktionsweise

Im Web Shop können Sie Push-Benachrichtigungen einrichten, die einzelne oder alle Nutzer direkt in ihrem Browser empfangen. Über Push-Benachrichtigungen können Sie Nutzer über neue Artikel, Werbeaktionen und Sonderangebote informieren.

Um einem Nutzer eine Benachrichtigung zu senden (zum Beispiel, nachdem er eine Schlacht verloren hat oder ihm Ressourcen ausgegangen sind), rufen Sie den Xsolla API-Aufruf zum Senden von Benachrichtigungen aufseiten des Spielservers auf.

Klickt der Nutzer auf die Benachrichtigung, gelangt er zum Web Shop, wo er die benötigten Artikel kaufen kann.

Push-Benachrichtigungen werden im Xsolla-Website-Baukasten konfiguriert und funktionieren nur bei veröffentlichten Web Shops.

Xsolla trackt keine Ingame-Ereignisse. Sie legen fest, wann der Spielserver den API-Aufruf ausführt und eine Benachrichtigung sendet, zum Beispiel:

Interaktionsablauf

1. Der Nutzer öffnet den Web Shop in einem Browser oder über eine installierte PWA und sieht ein Banner, in dem ihm angeboten wird, Benachrichtigungen zu abonnieren.
2. Der Nutzer klickt auf “Abonnieren” und erteilt im Browser seine Zustimmung, Benachrichtigungen zu empfangen.

    flowchart LR
      A[User opens Web Shop] --> B{Permission already granted?}
      B -- Yes --> C[Automatic subscription]
      B -- No --> D{Can the browser show the system prompt?}
      D -- Yes --> E[System prompt]
      D -- No --> F[Subscribe banner]
      F --> E
      E -- Allow --> G[Subscribed]
      E -- Block --> H[Not subscribed]
  

3. Der Web Shop registriert den Nutzer als Abonnenten im Xsolla-System. Das Abonnement ist mit dem Browser oder der auf dem Gerät des Nutzers installierten PWA verknüpft. Welche Benachrichtigungen Sie an den Nutzer senden können, hängt von dessen Autorisierungsstatus ab:

   • Ist der Nutzer im Web Shop angemeldet, wird seine ID mit dem Abonnement verknüpft – daraufhin können Sie diesem Nutzer persönliche Benachrichtigungen senden.
   • Ist der Nutzer nicht angemeldet, können Sie ihm nur im Rahmen von Massenbenachrichtigungen informieren. Sobald sich der Nutzer anmeldet, wird das Abonnement automatisch mit seiner Benutzer-ID verknüpft.

4. Der Spielserver führt den Xsolla-API-Aufruf aus und versendet die Benachrichtigungen.

5. Der Nutzer empfängt die Push-Benachrichtigung.

6. Der Nutzer klickt auf die Benachrichtigung und gelangt entweder zu der im Parameter data.url angegebenen Seite oder, falls kein Parameter übermittelt wurde, zur Web-Shop-Hauptseite. Besteht für den Nutzer eine aktive Sitzung im Web Shop, bleibt der Nutzer angemeldet.

  sequenceDiagram
    participant U as User
    participant WS as Web Shop
    participant G as Game
    participant X as Xsolla
    note over U,X: Subscription
    U->>WS: Opens the site / PWA
    WS->>U: Displays the subscription banner
    U->>WS: Subscribes and allows notifications
    WS->>X: Registers the subscriber (User ID, browser / PWA)
    X-->>WS: Confirms the subscription
    note over U,X: Sending a notification
    G->>X: Calls POST /messages/push/send
    X-->>G: Returns message_id
    X->>U: Sends the push notification
    U->>WS: Clicks the notification, follows data.url
    WS->>U: Displays store offers

Einrichtung

3. Wechseln Sie zum Abschnitt Push-Benachrichtigungen.
4. Aktivieren Sie den Schalter Benachrichtigungen aktivieren.
5. Kopieren Sie die Werte aus den Feldern Anwendungs-ID, Client-ID und Geheimer Client-Schlüssel – diese werden benötigt, um API-Anfragen vom Spielserver zu senden. Die Parameter werden einmalig erstellt, wenn der Schalter Benachrichtigungen aktivieren zum ersten Mal aktiviert wird, und gelten für das gesamte Projekt: Wenn das Projekt mehrere Websites umfasst, werden für alle Websites dieselben Werte verwendet.
6. Richten Sie bei Bedarf das Abonnement-Banner ein: Ändern Sie den Titel, die Beschreibung, das Symbol und den Schaltflächentext.
7. Damit die Website beim Öffnen automatisch um die Erlaubnis des Nutzers zum Versenden von Push-Benachrichtigungen bittet, aktivieren Sie den Schalter Berechtigung automatisch anfordern (optional). Ist der Schalter deaktiviert, wird erst um Erlaubnis gebeten, nachdem der Nutzer auf die Schaltfläche Abonnieren geklickt hat.
8. Veröffentlichen Sie die Website, damit die Änderungen übernommen werden.

9. Implementieren Sie auf dem Spielserver die Logik zum Senden von Push-Benachrichtigungen. Der Spielserver muss den API-Aufruf zum Senden von Benachrichtigungen ausführen und die ID des Nutzers in der Anfrage übermitteln.

Benachrichtigungen senden

Xsolla versendet keine Benachrichtigungen automatisch – der Versand wird stets von Ihrem Spielserver über einen API-Aufruf ausgelöst.

Basis-URL: https://messaging-platform.xsolla.com

Authentifizierung

Anfragen werden über das OAuth 2.0-Protokoll authentifiziert. Rufen Sie einen Server-JWT mithilfe des API-Aufrufs JWT generieren ab, indem Sie die folgenden Parameter übermitteln:

• grant_type – wie der JWT gewährt wird; übermitteln Sie den Wert client_credentials
• client_id – der Wert im Feld Client-ID aus den Einstellungen im Abschnitt Push-Benachrichtigungen
• client_secret – der Wert im Feld Geheimer Client-Schlüssel aus den Einstellungen im Abschnitt Push-Benachrichtigungen

Übermitteln Sie den erhaltenen Token im Authorization: Bearer <token>-Header.

Einem Nutzer Benachrichtigungen senden

Sendet dem per ID angegebenen Nutzer eine persönliche Push-Benachrichtigung. Die Benachrichtigung wird an alle Browser und installierten PWAs geliefert, bei denen der Nutzer Benachrichtigungen abonniert hat.

HTTP-Anfrage

POST https://messaging-platform.xsolla.com/api/v1/messages/push/send

Anfrage-Header

Anfrageparameter

Antwortparameter

Beispielanfrage

 1{
 2  "notification_type": "user_validation",
 3  "settings": {
 4    "project_id": 123456,
 5    "merchant_id": 789012
 6  },
 7  "user": {
 8    "id": "11111111-1111-1111-1111-111111111111"
 9  }
10}

Beispielantwort

1{
2  "message_ids": [
3"aa8ef5c2-front-4a3b-9d2e-example00001",
4"bb9fa6d3-front-4b4c-8e3f-example00002"
5    ]
6}

Allen Nutzern Benachrichtigungen senden

Sendet allen oder ausgewählten abonnierten Nutzern eine Push-Benachrichtigung. Die Benachrichtigung wird an alle Browser und installierten PWAs geliefert, bei denen der Nutzer Benachrichtigungen abonniert hat.

HTTP-Anfrage

POST https://messaging-platform.xsolla.com/api/v2/messages/push/send_batch

Anfrage-Header

Anfrageparameter

Antwortparameter

Beispielanfrage

 1POST /api/v2/messages/push/send_batch HTTP/1.1
 2Host: messaging-platform.xsolla.com
 3Authorization: Bearer <token>
 4Idempotency-Key: 5c1f0d2a-9b7e-4f36-8a1d-example00002
 5Content-Type: application/json
 6
 7{
 8  "app_id": "your_app_id",
 9  "recipients": {
10    "type": "all"
11  },
12  "title": "Seasonal sale!",
13  "body": "Up to 50% off in the Web Shop until the end of the week."
14}

 1POST /api/v1/messages/push/send_batch HTTP/1.1
 2Host: messaging-platform.xsolla.com
 3Authorization: Bearer <token>
 4Idempotency-Key: 7d2e1f3b-8c6a-4e57-9b2f-example00003
 5Content-Type: application/json
 6
 7{
 8  "app_id": "your_app_id",
 9  "recipients": {
10    "type": "external_user_id",
11    "external_user_id": ["player_123", "player_456"]
12  },
13  "title": "Seasonal sale!",
14  "body": "Up to 50% off in the Web Shop until the end of the week."
15}

Beispielantwort

1{
2  "summary": {
3    "failed_count": 0,
4    "success_count": 20
5  }
6}

 1{
 2  "results": [
 3    {
 4      "message_id": "cc0ab7e4-front-4c5d-9f4a-example00003",
 5      "player_id": "player_123",
 6      "status": "success"
 7    },
 8    {
 9      "message_id": "dd1bc8f5-front-4d6e-8a5b-example00004",
10      "player_id": "player_456",
11      "status": "success"
12    }
13  ]
14}