Esta API le permite gestionar cupones.
- Obtener lista de promociones del artículo
Crear promoción de descuento para un artículo
Eliminar la promoción de artículos
Obtener promoción del artículo
Actualizar la promoción del artículo
Obtener lista de promocio...
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/
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/item
- Mock serverhttps://xsolla.redocly.app/_mock/es/api/liveops/v3/project/{project_id}/admin/promotion/item
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/item?limit=0&offset=0'Respuesta
application/json
{ "active_promotions_count": 4, "inactive_promotions_count": 0, "promotions": [ { … }, { … }, { … }, { … } ], "total_promotions_count": 4 }
Ruta
Cuerpoapplication/jsonrequeridoID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.
Ejemplo: 44056
Objeto con datos de la promoción.
attribute_conditionsArray of tipo = string (object) or tipo = number (object) or tipo = date (object)(promotion_user-attribute_conditions_model-post)[ 1 .. 100 ] items
Condiciones para validar los atributos de usuario. Determina la disponibilidad de la promoción en función de si los atributos de usuario cumplen todas las condiciones especificadas.
Lista de ID de promociones a excluir al aplicar esta promoción.
Example: [12, 789].
Ejemplo: [12,789]
Nombre de la promoción. Debe contener pares clave/valor, en los cuales la clave es la configuración regional con el formato "^[a-z]{2}-[A-Z]{2}$", el valor es una cadena (string).
Ejemplo: {"en-US":"Promotion","ru-RU":"Акция"}
Matriz de objetos con condiciones que establecen el rango de precios para aplicar la promoción.
La promoción solo se aplica a los artículos cuyo precio cumple todas las condiciones de la matriz. Si transmite esta matriz, establezca el valor del objeto items en null.
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/item
- Mock serverhttps://xsolla.redocly.app/_mock/es/api/liveops/v3/project/{project_id}/admin/promotion/item
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://store.xsolla.com/api/v3/project/44056/admin/promotion/item \
-H 'Content-Type: application/json' \
-d '{
"attribute_conditions": [
{
"attribute": "race",
"operator": "eq",
"type": "string",
"value": "ork"
},
{
"attribute": "level",
"can_be_missing": true,
"operator": "eq",
"type": "number",
"value": "10"
}
],
"discount": {
"percent": "24.00"
},
"is_enabled": true,
"items": [],
"name": {
"en-US": "Ork set discount",
"ru-RU": "Скидка на набор для орка"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
]
}'Respuesta
application/json
{ "promotion_id": 2384756 }
Solicitud
Elimina la promoción de descuento. La promoción eliminada:
- Desaparece de la lista de promociones establecidas en su proyecto.
- Ya no se aplica al catálogo de artículos ni a la cesta. El usuario no puede obtener artículos con esta promoción.
Después de eliminarla, la promoción no se puede restaurar.
Seguridad
basicAuth
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/v3/project/{project_id}/admin/promotion/{promotion_id}/item
- Mock serverhttps://xsolla.redocly.app/_mock/es/api/liveops/v3/project/{project_id}/admin/promotion/{promotion_id}/item
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://store.xsolla.com/api/v3/project/44056/admin/promotion/111425/itemCatá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