Esta API le permite gestionar cupones.
- Obtener la lista de promociones de cupones
Obtener límites de código único de cupón
Activar promoción de cupones
Obtener códigos de cupón
Crear código de cupón
Generar códigos de cupón
Desactivar promoción de cupones
Obtener el límite de cupones para un usuario especificado
Consigue recompensas en forma de cupones
Canjear código de cupón
Crear promoción de cupones
Eliminar una promoción de cupones
Obtener promoción de cupones
Actualizar promoción de cupones
Obtener la lista de promo...
LiveOps API (2.0.0)
- Version: 2.0.0
- Servers:
https://store.xsolla.com/api - Contact Us by Email
- Contact URL: https://xsolla.com/
- Required TLS version: 1.2
LiveOps API ofrece endpoints para impulsar la participación de los jugadores.
Descargar descripción de OpenAPI
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/es/api/liveops/
https://store.xsolla.com/api/
Ruta
Cuerpoapplication/jsonID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.
Ejemplo: 44056
Código único de cupón. Contiene letras y números.
Predeterminado "WINTER2021"
Ejemplo: "WINTER2021"
- Mock serverhttps://xsolla.redocly.app/_mock/es/api/liveops/v2/project/{project_id}/coupon/redeem
- https://store.xsolla.com/api/v2/project/{project_id}/coupon/redeem
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://xsolla.redocly.app/_mock/es/api/liveops/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"
}
}'El cupón fue canjeado correctamente.
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": [ { … } ] }
Ruta
ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.
Ejemplo: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/es/api/liveops/v3/project/{project_id}/admin/coupon
- https://store.xsolla.com/api/v3/project/{project_id}/admin/coupon
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/es/api/liveops/v3/project/44056/admin/coupon?limit=50&offset=0'Respuesta
application/json
{ "active_promotions_count": 2, "inactive_promotions_count": 0, "items": [ { … }, { … } ], "total_promotions_count": 2 }
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)(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.
ID único de promoción. El external_id solo puede contener caracteres alfanuméricos latinos en minúsculas y mayúsculas, puntos, guiones y guiones bajos.
Predeterminado "coupon_external_id"
Ejemplo: "coupon_external_id"
Nombre de la promoción. Debe contener pares clave/valor en los cuales la clave es una configuración regional con el formato "^[a-z]{2}-[A-Z]{2}$", el valor es una cadena (string).
Predeterminado {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Ejemplo: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Periodos de validez de la promoción. Si se especifican varios periodos, es necesario tanto date_from como date_until.
Número de canjes por cada código.
Predeterminado 10
Ejemplo: 10
Limita el número total de cupones.
Predeterminado 10
Ejemplo: 10
- Mock serverhttps://xsolla.redocly.app/_mock/es/api/liveops/v3/project/{project_id}/admin/coupon
- https://store.xsolla.com/api/v3/project/{project_id}/admin/coupon
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/es/api/liveops/v3/project/44056/admin/coupon \
-H 'Content-Type: application/json' \
-d '{
"attribute_conditions": [
{
"attribute": "account_status",
"can_be_missing": false,
"operator": "eq",
"type": "string",
"value": "golden"
}
],
"bonus": [
{
"quantity": 1,
"sku": "com.xsolla.elven_sword_2"
}
],
"external_id": "coupon_external_id",
"name": {
"de-DE": "Neujahrsbonus",
"en-US": "New Year Bonus"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"redeem_code_limit": 1,
"redeem_total_limit": 100,
"redeem_user_limit": 1
}'Respuesta
application/json
{ "external_id": "coupon_external_id" }
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