Saltar al contenido
/
Establecer el límite de l...

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

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

Aumentar el límite de la promoción para el usuario especificadoServer-sideAdmin

Solicitud

Aumenta el número restante de veces que el usuario especificado puede utilizar la promoción dentro del límite aplicado.

La API de límite de usuarios permite limitar el número de veces que los usuarios pueden usar una promoción. Para configurar el límite de usuario, vaya a la sección Admin del tipo de promoción deseado:

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
promotion_idintegerrequerido

ID de promoción. Identificador único de la promoción en el proyecto.

Ejemplo: 111425
Cuerpoapplication/json
availableinteger(User-limit_available)>= 1requerido

Número restante de artículos o usos de la promoción disponibles para el usuario dentro del límite aplicado.

userobject(User-limit_user)requerido
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$requerido

ID externo del usuario.

curl -i -X POST \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/user/limit/promotion/id/111425 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 1,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Respuestas

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

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

Establecer el límite de la promoción para el usuario especificadoServer-sideAdmin

Solicitud

Establece el número de veces que el usuario especificado puede usar una promoción dentro del límite aplicado después de que se haya aumentado o reducido.

La API de límite del usuario le permite limitar el número de veces que los usuarios pueden utilizar una promoción. Para configurar el límite de usuario, vaya a la sección Admin del tipo de promoción deseado:

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
promotion_idintegerrequerido

ID de promoción. Identificador único de la promoción en el proyecto.

Ejemplo: 111425
Cuerpoapplication/json
availableinteger(User-limit_available_flexible)>= 0requerido

Número restante de artículos o usos de la promoción disponibles para el usuario dentro del límite aplicado.

userobject(User-limit_user)requerido
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$requerido

ID externo del usuario.

curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/user/limit/promotion/id/111425 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 0,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Respuestas

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

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

Actualizar el límite de promoción para los usuariosServer-sideAdmin

Solicitud

Actualiza el límite de la promoción para que un usuario pueda utilizar esta promoción de nuevo. Si el parámetro user es null, esta llamada actualiza este límite para todos los usuarios.

La API de límite del usuario le permite limitar el número de veces que los usuarios pueden usar una promoción. Para configurar el límite del usuario, vaya a la sección Admin del tipo de promoción deseada:

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
promotion_idintegerrequerido

ID de promoción. Identificador único de la promoción en el proyecto.

Ejemplo: 111425
Cuerpoapplication/json
userobject or null(User-limit_user_flexible)requerido
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$

ID externo del usuario.

curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/user/limit/promotion/id/111425/all \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Respuestas

El límite de la promoción se actualizó correctamente.

Respuesta
Sin contenido

Admin

Operaciones

Cliente

Operaciones

Cliente de clanes

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones

Cliente

Operaciones