Esta API le permite gestionar cupones.
- Obtener regla de filtro del catálogo
Obtener lista de reglas de filtrado del catálogo
Crear regla de filtrado del catálogo
Obtener todas las reglas del catálogo para la búsqueda en el lado del cliente
Eliminar regla de filtro del catálogo
Revisar regla de filtro del catálogo
Actualizar regla de filtro del catálogo
Obtener regla de filtro d...
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/user/attribute/rule/{rule_id}
- Mock serverhttps://xsolla.redocly.app/_mock/es/api/liveops/v2/project/{project_id}/admin/user/attribute/rule/{rule_id}
- 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/user/attribute/rule/1Ruta
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/user/attribute/rule/{rule_id}
- Mock serverhttps://xsolla.redocly.app/_mock/es/api/liveops/v2/project/{project_id}/admin/user/attribute/rule/{rule_id}
- 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/user/attribute/rule/1La regla se recibió correctamente.
attribute_conditionsArray of tipo = string (object) or tipo = number (object) or tipo = date (object)(personalized-catalog_user-attribute_conditions_model-get)[ 1 .. 100 ] itemsrequerido
Condiciones para validar los atributos de usuario. Determina la disponibilidad de artículos en el catálogo en función de si los atributos de usuario cumplen todas las condiciones especificadas.
One of:
attribute_conditions[].attributestring(user-attribute_conditions_properties_attribute)[ 1 .. 255 ] characters^[-_.\d\w]+$
Código de atributo de usuario.
Indica que se cumple la condición aunque falte el atributo en los atributos del usuario. Transmita true para mostrar el elemento a los usuarios que no tengan este atributo. Los usuarios que tengan el atributo, pero el valor no coincida con el especificado en la condición, no verán el artículo. false - Los usuarios que tengan el atributo, pero el valor no coincida con el especificado en la condición, o falte el atributo, no verán el artículo.
Tipo de operación realizada por condición. Para el tipo de atributo string.
| Enumeración Valor | Descripción |
|---|---|
| eq | Igual que |
| ne | No es igual que |
Tipo de atributo de usuario.
Valor"string"
Si el artículo se muestra a usuarios no autorizados. Si es true, el artículo se muestra al usuario no autorizado independientemente de las reglas de visualización del catálogo. Es false por defecto.
Tipo de lote. Se devuelve si el tipo de artículo es un lote.
Enumeración"standard""virtual_currency_package"
Nombre legible de una regla. Se utiliza para visualizar una regla en Cuenta del editor.
Respuesta
application/json
{ "attribute_conditions": [ { … } ], "is_enabled": true, "is_satisfied_for_unauth": true, "items": [ { … } ], "name": "Ork race armor rule", "rule_id": 1 }
Ruta
Cuerpoapplication/jsonID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.
Ejemplo: 44056
attribute_conditionsArray of tipo = string (object) or tipo = number (object) or tipo = date (object)(personalized-catalog_user-attribute_conditions_model-post)[ 1 .. 100 ] items
Condiciones para validar los atributos de usuario. Determina la disponibilidad de artículos en el catálogo en función de si los atributos de usuario cumplen todas las condiciones especificadas.
Si el artículo se muestra a usuarios no autorizados. Si es true, el artículo se muestra al usuario no autorizado independientemente de las reglas de visualización del catálogo. Es false por defecto.
- https://store.xsolla.com/api/v2/project/{project_id}/admin/user/attribute/rule/{rule_id}
- Mock serverhttps://xsolla.redocly.app/_mock/es/api/liveops/v2/project/{project_id}/admin/user/attribute/rule/{rule_id}
- 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/user/attribute/rule/1 \
-H 'Content-Type: application/json' \
-d '{
"is_enabled": false
}'