Esta API le permite gestionar cupones.
- Obtener lista de artículos con puntos de valor
Obtener lista de puntos de valor
Crear un punto de valor
Eliminar puntos de valor
Obtener punto de valor
Actualizar punto de valor
Eliminar puntos de valor de los artículos
Actualizar parcialmente los puntos de valor para los artículos
Establecer puntos de valor para los artículos
Obtener lista de cadenas de recompensas
Crear una cadena de recompensas
Eliminar cadena de recompensas
Obtener cadena de recompensas
Actualizar cadena de recompensas
Restablecer cadena de recompensas
Activar/desactivar cadena de recompensas
Obtener lista de artículo...
API de LiveOps (2.0.0)
- Versión: 2.0.0
- Servidores:
https://store.xsolla.com/api - Contacte con nosotros por correo electrónico
- URL de contacto: https://xsolla.com/
- Versión de TLS requerida: 1.2
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.
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
Idiomas
Servidores
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/es/api/liveops/
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
Ruta
ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.
Ejemplo: 44056
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards
- Mock serverhttps://xsolla.redocly.app/_mock/es/api/liveops/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/items/value_point_3/value_points/rewardsRespuesta
Sin contenidoRuta
ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.
Ejemplo: 44056
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards
- Mock serverhttps://xsolla.redocly.app/_mock/es/api/liveops/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/items/value_point_3/value_points/rewardsRespuesta
application/json
{ "items": [ { … }, { … } ] }
Solicitud
Actualiza parcialmente la cantidad de puntos de valor de uno o más artículos según el SKU del artículo. Los usuarios reciben estos puntos de valor después de comprar los artículos especificados.
Principios de actualización de los puntos de valor:
- Si un artículo aún no tiene puntos de valor, el envío de un valor distinto de cero en el campo
amountlos genera. - Si un artículo ya tiene puntos de valor, enviar un valor distinto de cero en el campo
amountlos actualiza. - Si
amountse establece en 0, se eliminan los puntos de valor existentes para ese artículo.
A diferencia del método PUT (Establecer puntos de valor para artículos), este método PATCH no sobrescribe todos los puntos de valor existentes para los artículos del proyecto, solo actualiza los artículos especificados.
Una sola solicitud puede actualizar hasta 100 artículos. No se pueden incluir SKU de artículos duplicados en la misma solicitud.
Seguridad
basicAuth
Ruta
Cuerpoapplication/jsonArray [ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.
Ejemplo: 44056
ID único del artículo. El SKU solo puede contener caracteres alfanuméricos latinos en minúsculas y mayúsculas, puntos, guiones y guiones bajos.
Ejemplo: "booster_mega_1"
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards
- Mock serverhttps://xsolla.redocly.app/_mock/es/api/liveops/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/items/value_point_3/value_points/rewards \
-H 'Content-Type: application/json' \
-d '[
{
"amount": 100,
"sku": "booster_1"
},
{
"amount": 0,
"sku": "booster_mega"
}
]'Respuesta
Sin contenido