Notifications push

Comment ça marche

Dans le Web Shop, vous pouvez configurer des notifications push : des messages personnels ou envoyés en masse que les utilisateurs reçoivent directement dans leur navigateur. Elles vous permettent de les informer des nouveaux objets, nouvelles promotions et offres spéciales.

Pour envoyer une notification à un utilisateur, par exemple, après la perte d’une bataille ou l’épuisement d’une ressource, appelez l’API Xsolla d’envoi de notifications côté serveur du jeu.

En appuyant sur la notification, l’utilisateur est redirigé vers le Web Shop pour acheter les objets dont il a besoin.

Les notifications push sont configurées dans le constructeur de site Xsolla et fonctionnent uniquement pour les Web Shops publiés.

Xsolla ne suit pas les événements en jeu. Vous définissez quand le serveur du jeu doit appeler l’API pour envoyer une notification, par exemple :

Flux d’interaction

1. L’utilisateur ouvre le Web Shop dans un navigateur ou via une PWA installée et voit une bannière l’invitant à s’abonner aux notifications.
2. L’utilisateur appuie sur S’abonner et autorise les notifications dans l’invite système du navigateur.

    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. Le Web Shop enregistre l’utilisateur comme abonné dans Xsolla. L’abonnement est lié au navigateur ou à la PWA installée sur son appareil. Le type de notifications disponibles dépend de son statut :

   • Utilisateur connecté au Web Shop : l’abonnement est lié à son ID et permet l’envoi de notifications personnalisées.
   • Utilisateur non connecté : seules les notifications en masse sont disponibles. L’abonnement sera automatiquement associé à son ID après connexion.

4. Le serveur du jeu effectue l’appel API Xsolla pour envoyer des notifications.

5. L’utilisateur reçoit la notification push.

6. L’utilisateur appuie sur la notification et accède au Web Shop à l’adresse indiquée dans le paramètre data.url ou par défaut à la page d’accueil. Si l’utilisateur dispose d’une session active dans le Web Shop, il reste connecté.

  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

Comment configurer

3. Accédez à la section Push notifications.
4. Activez la bascule Enable notifications.
5. Copiez les valeurs des champs Application ID, Client ID et Client secret key : elles seront nécessaires pour envoyer des requêtes API depuis le serveur du jeu. Ces paramètres sont créés une seule fois, lors de la première activation de la bascule Enable notifications, et sont utilisés pour l’ensemble du projet. Si le projet contient plusieurs sites, les mêmes valeurs sont utilisées pour chacun d’eux.
6. Configurez la bannière d’abonnement si nécessaire : modifiez le titre, la description, l’icône et le texte du bouton.
7. Pour que le site demande automatiquement la permission de l’utilisateur d’envoyer des notifications push à l’ouverture, activez la bascule Auto-request permission (facultatif). Si cette option est désactivée, l’autorisation sera demandée uniquement après que l’utilisateur a appuyé sur le bouton Subscribe.
8. Pour appliquer les modifications, publiez le site.

9. Sur le serveur du jeu, implémentez la logique d’envoi des notifications push. Le serveur du jeu doit effectuer l’appel API pour envoyer des notifications et passer l’ID utilisateur dans la requête.

Envoi de notifications

Xsolla n’envoie pas automatiquement de notifications : l’envoi est toujours déclenché par votre serveur de jeu via un appel API.

URL de base : https://messaging-platform.xsolla.com

Authentification

Les requêtes sont authentifiées via le protocole OAuth 2.0. Obtenez un JWT serveur en utilisant l’appel API Generate JWT , en passant les paramètres suivants :

• grant_type — type de jeton JWT, passez la valeur client_credentials
• client_id — valeur du champ Client ID des paramètres de la section Push notifications
• client_secret — valeur du champ Client secret key des paramètres de la section Push notifications

Passez le jeton reçu dans l’en-tête Authorization: Bearer <token>.

Envoyer une notification à un utilisateur

Envoie une notification push personnelle à un utilisateur par son ID. La notification est distribuée à tous les navigateurs et PWA installées où l’utilisateur s’est abonné aux notifications.

Requête HTTP

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

En-têtes de requête

Paramètres de requête

Paramètres de réponse

Exemple de requête

 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}

Exemple de réponse

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

Envoyer une notification à tous les utilisateurs

Envoie une notification push à tous à une sélection d’utilisateurs. La notification est distribuée à tous les navigateurs et PWA installées où l’utilisateur s’est abonné aux notifications.

Requête HTTP

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

En-têtes de requête

Paramètres de requête

Paramètres de réponse

Exemple de requête

 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}

Exemple de réponse

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}