Transferir compras al usuario

Implemente la concesión de compras al usuario en su aplicación empleando la información recibida en los webhooks de Xsolla sobre los detalles de la transacción y los artículos adquiridos.

Para que la tienda en el juego y el sistema de gestión de pagos funcionen a pleno rendimiento, es necesario implementar el procesamiento de los principales webhooks:

El siguiente esquema muestra el proceso de compra y de devolución de artículos utilizando webhooks combinados.

  sequenceDiagram
    participant User
    participant GameClient as Game Client
    participant Xsolla
    participant GameServer as Game Server
    %% Item Purchase
        Note over User, GameServer: Item purchase
        User ->> GameClient: Logs in
        GameClient ->> Xsolla: Sends user authentication request
        Xsolla -->> GameClient: Returns JWT / OAuth 2.0 token
        GameClient ->> Xsolla: Sends JWT, project ID, pagination parameters
        Xsolla -->> GameClient: Returns array of items
        GameClient -->> User: Displays storefront
        User ->> GameClient: Selects item and clicks Buy
        GameClient ->> Xsolla: Creates order request
        Xsolla -->> GameClient: Returns payment token
        GameClient ->> Xsolla: Opens payment UI URL with received token
        Xsolla ->> GameServer: Sends User validation webhook
        GameServer -->> Xsolla: Returns success status code
        Xsolla -->> User: Displays payment UI
        User ->> Xsolla: Chooses payment method and clicks Pay
        Xsolla ->> GameServer: Sends Successful payment for order webhook
        GameServer ->> GameServer: Grants purchases to user
        GameServer -->> Xsolla: Returns success status code
        Xsolla -->> User: Shows successful purchase screen
    %% Refund / Chargeback
        Note over User, GameServer: Refund / Chargeback
        User ->> Xsolla: Requests refund or chargeback
        Xsolla ->> GameServer: Sends Order cancellation webhook
        GameServer ->> GameServer: Removes items from user inventory
        GameServer -->> Xsolla: Returns success status code
        Xsolla -->> User: Refunds the payment

Si la personalización del catálogo de artículos está implementada en el lado de su aplicación, establezca el procesamiento de Personalización del catálogo en el lado del socio.

Establecer webhooks en Cuenta del editor

1. Abra su proyecto en Cuenta del editor y vaya a Project settings > Webhooks.
2. En el campo Webhook server, especifique la URL de su servidor donde quiere recibir los webhooks en formato https://example.com. También puede especificar la URL que encuentre en una herramienta para probar webhooks.
3. Por defecto, se genera una clave secreta para firmar los webhooks del proyecto. Si quiere generar una nueva clave secreta, haga clic en el icono de actualización.
4. Haga clic en Enable webhooks.

Probar los webhooks en Cuenta del editor

Cuando habilite los webhooks en su proyecto, aparecerá una sección para probarlos en Cuenta del editor, debajo de la configuración avanzada.

Puede probar los siguientes webhooks:

En ausencia de valores reales, puede introducir valores arbitrarios.

También puede probar los webhooks al realizar compras en el modo Aislador de proceso (sandbox) o en el modo real. La prueba de Refund solo está disponible en modo real.

Enviar respuestas al webhook

Para confirmar la recepción del webhook, su servidor debe devolver:

• código HTTP 200, 201 o 204 en el caso de una respuesta correcta.
• Código HTTP 400 con descripción del problema si no se ha encontrado el usuario especificado o se ha transmitido una firma no válida.

Su controlador de webhook también puede devolver un código 5xx en caso de problemas temporales en su servidor.

Próximos pasos

1. Configurar la venta de suscripciones (opcional).
2. Configurar la autenticación de usuarios.

Configurar la información de los artículos en los webhooks

Puede configurar qué datos de los artículos se incluyen en los webhooks Pago del pedido realizado correctamente y Cancelación del pedido a través de la matriz de items.

Activar la inclusión de parámetros adicionales

Active la inclusión de parámetros adicionales que indiquen:

• si el artículo es gratuito (is_free)
• si el artículo es una bonificación (is_bonus)
• si el artículo forma parte de un lote (is_bundle_content)

Para recibir estos parámetros, debe cambiar sus webhooks a la versión 2 mediante la llamada a la API Actualizar la información sobre la configuración de webhooks. En la versión 1 (predeterminada), estos parámetros no están disponibles.

Ejemplo de matriz de artículos con parámetros adicionales:

 1"items": [
 2      {
 3        "sku": "com.xsolla.item_new_1",
 4        "type": "bundle",
 5        "is_pre_order": false,
 6        "is_free": false,
 7        "is_bonus": false,
 8        "is_bundle_content": false,
 9        "quantity": 1,
10        "amount": "1000",
11        "promotions": []
12      },
13      {
14        "sku": "com.xsolla.gold_1",
15        "type": "virtual_currency",
16        "is_pre_order": false,
17        "is_free": false,
18        "is_bonus": false,
19        "is_bundle_content": true,
20        "quantity": 1500,
21        "amount": "[null]",
22        "promotions": []
23      }
24 ]

Desactivar la inclusión del contenido del lote

Por defecto, los webhooks incluyen todos los artículos del lote como una lista de artículos individuales. Puede configurar el webhook para que solo incluya el lote en sí, sin detallar su contenido.

En este caso, los artículos incluidos en el lote no se incluyen en la matriz de items. En la matriz que se muestra arriba, el artículo con el SKU com.xsolla.gold_1, que forma parte del lote, está excluido.

Ejemplo de matriz de artículos cuando el contenido del lote está desactivado:

 1
 2"items": [
 3      {
 4        "sku": "com.xsolla.item_new_1",
 5        "type": "bundle",
 6        "is_pre_order": false,
 7        "is_free": false,
 8        "is_bonus": false,
 9        "is_bundle_content": false,
10        "quantity": 1,
11        "amount": "1000",
12        "promotions": []
13      }
14 ]

Para desactivar la inclusión del contenido del lote, contacte con su gestor del éxito del cliente o envíe un correo electrónico a csm@xsolla.com.

Enlaces útiles