Saltar al contenido
/
Consigue recompensas en f...

API de LiveOps (2.0.0)

Descripción general

LiveOps es un conjunto de herramientas diseñado para fomentar la participación de los jugadores mediante promociones y ofertas personalizadas.

Utilice la API para gestionar las siguientes funciones:

  • Promociones: cree y gestione cupones, códigos promocionales, descuentos y campañas de bonificaciones.
  • Personalización: especifique los requisitos para mostrar el catálogo de artículos y aplicar promociones solo para usuarios autorizados.
  • Límites de promociones: establezca un límite de veces que un usuario puede usar una promoción y configure reinicios programados para dichos límites.
  • Cadenas de recompensas y puntos de valor: configure progresiones de recompensas vinculadas a la acumulación de puntos de valor.
  • Cadenas diarias: configure recompensas diarias recurrentes para animar a los usuarios a iniciar sesión con frecuencia.
  • Cadenas de ofertas: cree ofertas de compra secuenciales con precios por paso y opciones de recompensas gratuitas.
  • Venta adicional: un método de venta en el que se ofrece al usuario la posibilidad de comprar un artículo con valor añadido.

Llamadas API

La API se divide en los siguientes grupos:

  • Admin: llamadas para crear, actualizar, activar y eliminar campañas y configuraciones de cadenas. La autenticación se realiza mediante autenticación de acceso básica con sus credenciales de comerciante o de proyecto.
  • Client: llamadas para buscar promociones disponibles, obtener cadenas activas, canjear códigos y reclamar recompensas en nombre de usuarios finales autenticados. La autenticación se realiza mediante JWT de usuario.
Descargar descripción de OpenAPI
index.json
index.yaml
Idiomas
Servidores
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/es/api/liveops/

Común

Operaciones

Cupones

Esta API le permite gestionar cupones.

Operaciones

Obtener el límite de cupones para un usuario especificadoServer-sideAdmin

Solicitud

Obtiene el número restante de veces que el usuario especificado puede utilizar el cupón.

La API de límite del usuario le permite limitar el número de veces que los usuarios pueden utilizar un cupón. Para configurar este límite de usuario, vaya a Admin:

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.

Ejemplo: 44056
external_idintegerrequerido

ID externo de la promoción. Identificador único de la promoción dentro del proyecto.

Ejemplo: coupon_44056_1
Consulta
user_external_idstringrequerido

ID externo del usuario

Ejemplo: user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f
curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/user/limit/coupon/external_id/coupon_44056_1?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'

Respuestas

Se recibieron correctamente los límites de cupón para un usuario.

Cuerpoapplication/json
per_userobject
Respuesta
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

Consigue recompensas en forma de cuponesClient-side

Solicitud

Obtiene las recompensas en forma de cupones por su código. Puede utilizarse para permitir a los usuarios elegir uno de varios artículos como bonificación. El caso más habitual es elegir un DRM (gestión de derechos digitales) si el cupón contiene un juego como bonificación (type=unit).

Seguridad
XsollaLoginUserJWT
Ruta
project_idintegerrequerido

ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.

Ejemplo: 44056
coupon_codestring[ 1 .. 128 ] charactersrequerido

Código único que distingue entre mayúsculas y minúsculas. Contiene letras y números.

Ejemplo: WINTER2021
curl -i -X GET \
  https://store.xsolla.com/api/v2/project/44056/coupon/code/WINTER2021/rewards \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respuestas

La lista de recompensas de cupones se recibió correctamente.

Cuerpoapplication/json
bonusArray of objects(Promotions_200-coupon-bonus-reward)
discountobject or null(Promotions_200-coupon-discount-reward)

Porcentaje de descuento. El precio de la cesta se reducirá utilizando un valor calculado utilizando este porcentaje y luego se redondeará al segundo decimal.

is_selectableboolean

Si es true, el usuario debe elegir la bonificación antes de canjear un cupón.

Respuesta
application/json
{
  "bonus": [
    { … },
    { … }
  ],
  "discount": {
    "percent": "10.00"
  },
  "is_selectable": true
}

Canjear código de cupónClient-side

Solicitud

Canjea un código de cupón. El usuario recibe una bonificación tras canjear un cupón.

Seguridad
XsollaLoginUserJWT
Ruta
project_idintegerrequerido

ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.

Ejemplo: 44056
Cuerpoapplication/json
coupon_codestring[ 1 .. 128 ] characters

Código único de cupón. Contiene letras y números.

Predeterminado "WINTER2021"
Ejemplo: "WINTER2021"
selected_unit_itemsobject(Promotions_selected_unit_items)

La recompensa que selecciona un usuario. La clave del objeto es un SKU de una unidad, y el valor es un SKU de uno de los artículos de una unidad.

Ejemplo: {"game_1":"game_1_steam","game_2":"game_2_playstation"}
curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/coupon/redeem \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "WINTER2021",
    "selected_unit_items": {
      "game_1": "game_1_steam",
      "game_2": "game_2_playstation"
    }
  }'

Respuestas

El cupón fue canjeado correctamente.

Cuerpoapplication/json
itemsArray of objects
Ejemplo: [{"attributes":[],"description":"Take it, take it all! All of Xsolla's riches in one Mega Booster.","groups":[{"external_id":"powerups","name":"Power Ups"}],"image_url":"https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png","is_free":false,"name":"Xsolla Booster Mega","price":{"amount":"50.0000000000000000","amount_without_discount":"100.0000000000000000","currency":"USD"},"quantity":1,"sku":"com.xsolla.booster_mega_1","type":"virtual_good","virtual_item_type":"consumable","virtual_prices":[]}]
Respuesta
application/json
{
  "items": [
    { … }
  ]
}

Códigos promocionales

Esta API permite gestionar códigos promocionales.

Operaciones

Ofertas únicas por catálogo

Esta API le permite gestionar ofertas de catálogo únicas.

Operaciones

Descuentos

Esta API le permite gestionar promociones de descuento.

Operaciones

Bonificaciones

Esta API permite gestionar promociones de bonificaciones.

Operaciones

Catálogo personalizado

Esta API permite especificar reglas para los atributos de usuario. Si el usuario cumple todas las condiciones de una regla específica, se mostrarán los elementos personalizados.

Para promociones personalizadas, consulte la sección Promotions.

Para transmitir atributos antes de una compra, puede utilizar Xsolla Login API o transmitirlos a la propiedad user.attributes mientras se genera el token utilizando Pay Station API.

Operaciones

Gestión

Operaciones

Admin

Operaciones

Cliente

Operaciones

Cliente de clanes

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones

Cliente

Operaciones