Notificaciones push

Cómo funciona

En Web Shop, puede configurar notificaciones push: mensajes personales o masivos que los usuarios reciben directamente en su navegador. Las notificaciones push le permiten informar a los usuarios sobre nuevos artículos, promociones y ofertas especiales.

Para enviar una notificación a un usuario, por ejemplo, después de que pierda una batalla o se quede sin recursos, llame a la API de Xsolla para enviar notificaciones desde el servidor del juego.

Después de hacer clic en la notificación, el usuario va a la Web Shop, donde puede comprar los artículos que necesita.

Las notificaciones push se configuran en el creador de sitios web de Xsolla y solo funcionan en las Web Shop publicadas.

Xsolla no realiza un seguimiento de los eventos del juego. Usted define cuándo el servidor del juego realiza la llamada API para enviar una notificación, por ejemplo:

Flujo de interacción

1. El usuario abre la Web Shop en un navegador o a través de una PWA instalada y ve un banner que le ofrece la posibilidad de suscribirse a las notificaciones. 2. El usuario hace clic en Subscribe y autoriza las notificaciones en el mensaje del sistema del navegador.

  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. La Web Shop registra al usuario como suscriptor en el sistema de Xsolla. La suscripción está vinculada al navegador o a la PWA instalada en el dispositivo del usuario. Las notificaciones que puede enviar al usuario dependen de su estado de autorización:

   • Si el usuario ha iniciado sesión en la Web Shop, su ID queda vinculado a la suscripción, por lo que puede enviarle notificaciones personales.
   • Si el usuario no ha iniciado sesión, solo se le pueden enviar notificaciones masivas; una vez que el usuario inicie sesión, la suscripción se vinculará automáticamente a su ID de usuario.

4. El servidor del juego realiza la llamada API de Xsolla para enviar notificaciones.

5. El usuario recibe la notificación push.

6. El usuario hace clic en la notificación y va a la Web Shop, a la página especificada en el parámetro data.url, o a la página principal si no se transmite el parámetro. Si el usuario tiene una sesión activa en la Web Shop, permanece con la sesión iniciada.

  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

Cómo obtenerlo

3. Vaya a la sección Push notifications.
4. Active la opción Enable notifications.
5. Copie los valores de los campos Application ID, Client ID y Client secret key; los necesitará para enviar solicitudes de API desde el servidor del juego. Estos parámetros se crean una sola vez, al activar por primera vez la opción Enable notifications, y se utilizan para todo el proyecto: si hay varios sitios en el proyecto, se utilizan los mismos valores para todos.
6. Configure el banner de suscripción si es necesario: cambie el título, la descripción, el icono y el texto del botón.
7. Para que el sitio solicite automáticamente el permiso del usuario para enviar notificaciones push al abrirse, active la opción Auto-request permission (opcional). Si la opción está desactivada, el permiso solo se solicitará después de que el usuario haga clic en el botón Subscribe.
8. Para aplicar los cambios, publique el sitio.

9. En el servidor del juego, implemente la lógica de envío de notificaciones push. El servidor del juego debe realizar la llamada API para enviar las notificaciones y transmitir el ID de usuario en la solicitud.

Envío de notificaciones

Xsolla no envía notificaciones de forma automática: el envío siempre lo inicia el servidor de su juego mediante una llamada API.

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

Autenticación

Las solicitudes se autentican mediante el protocolo OAuth 2.0. Obtenga un JWT del servidor utilizando la llamada API Generar JWT, transmitiendo los siguientes parámetros:

• grant_type: tipo de concesión JWT, transmita el valor client_credentials
• client_id: el valor del campo Client ID de la configuración de la sección Push notifications
• client_secret: el valor del campo Client secret key de la configuración de la sección Push notifications

Transmita el token recibido en el encabezado Authorization: Bearer <token>.

Enviar notificación al usuario

Envía una notificación push personalizada a un usuario mediante su ID. La notificación se envía a todos los navegadores y a las PWA instaladas en las que el usuario se haya suscrito a las notificaciones.

Solicitud HTTP

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

Encabezados de solicitud

Parámetros de solicitud

Parámetros de respuesta

Ejemplo de solicitud

 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}

Ejemplo de respuesta

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

Enviar notificación a todos los usuarios

Envía una notificación push a todos los usuarios suscritos o a los seleccionados. La notificación se envía a todos los navegadores y a las PWA instaladas en las que el usuario se haya suscrito a las notificaciones.

Solicitud HTTP

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

Encabezados de solicitud

Parámetros de solicitud

Parámetros de respuesta

Ejemplo de solicitud

 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}

Ejemplo de respuesta

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}