- Получение акции с промокодами
LiveOps API (2.0.0)
- Версия: 2.0.0
- Серверы:
https://store.xsolla.com/api - Свяжитесь с нами по электронной почте
- Адрес для связи: https://xsolla.com/
- Требуемая версия TLS: 1.2
LiveOps — это набор инструментов для повышения вовлеченности пользователей с помощью акций и персонализированных предложений.
Используйте методы API, чтобы управлять такими возможностями, как:
- Промоакции — создание и управление купонами, промокодами, скидками и бонусными кампаниями.
- Персонализация — возможность задавать условия отображения каталога товаров и применения акций только для определенного круга авторизованных пользователей.
- Лимиты промоакций — настройка ограничений на количество использований акции пользователем, а также периодов автоматического обновления ограничений.
- Цепочки наград и призовые баллы — настройка цепочек наград, привязанных к накоплению призовых баллов.
- Ежедневные цепочки — настройка повторяющихся ежедневных наград для мотивации регулярных входов в игру.
- Цепочки предложений — построение последовательных предложений покупки с ценой на каждом шаге и возможностью бесплатных наград.
- Апселл — способ продаж, при котором пользователю предлагается купить товар с дополнительной ценностью.
Методы API делятся на следующие группы:*
Client — методы для получения доступных промоакций, получения активных цепочек, активации кодов и получения наград от имени аутентифицированных конечных пользователей. Аутентификация выполняется по JWT пользователя.
Запрос
Удаляет акцию с промокодами. Удаленная акция:
- Пропадет из списка акций, настроенных в вашем проекте.
- Не будет применяться к каталогу товаров и к корзине. Пользователь не сможет получить бонусные товары или купить товары с применением этой акции.
После удаления акция не может быть восстановлена. Промокоды из удаленной акции могут быть добавлены в существующие акции.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promocode/{external_id}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/liveops/v3/project/{project_id}/admin/promocode/{external_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/v3/project/44056/admin/promocode/coupon_44056_1ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promocode/{external_id}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/liveops/v3/project/{project_id}/admin/promocode/{external_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/v3/project/44056/admin/promocode/coupon_44056_1Промокод успешно получен.
Условия для проверки атрибутов пользователя. Определяют доступность акции на основе соответствия атрибутов пользователя всем указанным условиям.
Список товаров, на которые действует скидка по промокоду.
Список акций, которые исключаются при применении этой акции.
Example: [12, 789]
Уникальный ID акции. external_id может содержать только строчные и заглавные латинские буквы, цифры, тире и подчеркивания.
Массив объектов с условиями, задающими ценовой диапазон применения акции для отдельных товаров в корзине.
Стоимость каждого товара в корзине пользователя сравнивается с заданным в условии ценовым диапазоном. Бонусы и скидки применяются только к тем товарам в корзине, цена которых удовлетворяет условию.
Если вы передаете этот массив, в массиве discounted_items передайте значение null.
Название акции. Данный параметр должен содержать пары ключ/значение, где ключ — это локаль в формате "^[a-z]{2}-[A-Z]{2}$", значение — строка.
Массив объектов с условиями, задающими ценовой диапазон применения акции для отдельных товаров в корзине.
Стоимость каждого товара в корзине пользователя сравнивается с заданным в условии ценовым диапазоном. Бонусы и скидки применяются только к тем товарам в корзине, цена которых удовлетворяет условию.
Если вы передаете этот массив, в массиве discounted_items передайте значение null.
Периоды действия акции. Если указано больше одного периода, параметры date_from и date_until становятся обязательными.
Количество погашений по коду.
Ограничивает общее количество купонов.
Ограничивает общее количество купонов, погашаемых одним пользователем.
{ "bonus": [ { … } ], "discount": { "percent": "10.99" }, "discounted_items": null, "excluded_promotions": [ 23, 45 ], "external_id": "summer20221", "is_enabled": true, "name": { "en-US": "Coupon name", "ru-RU": "Название купона" }, "promotion_periods": [ { … }, { … } ], "redeem_code_limit": 1, "redeem_total_limit": 100, "redeem_user_limit": null, "total_limit_state": { "available": 50, "reserved": 10, "used": 40 } }
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Условия для проверки атрибутов пользователя. Определяют доступность акции на основе соответствия атрибутов пользователя всем указанным условиям.
Список товаров, на которые действует скидка по промокоду.
Список акций, которые исключаются при применении этой акции.
Example: [12, 789]
Массив объектов с условиями, задающими ценовой диапазон применения акции для отдельных товаров в корзине.
Стоимость каждого товара в корзине пользователя сравнивается с заданным в условии ценовым диапазоном. Бонусы и скидки применяются только к тем товарам в корзине, цена которых удовлетворяет условию.
Если вы передаете этот массив, в массиве discounted_items передайте значение null.
Название акции. Данный параметр должен содержать пары ключ/значение, где ключ — это локаль в формате "^[a-z]{2}-[A-Z]{2}$", значение — строка.
Массив объектов с условиями, задающими ценовой диапазон применения акции для отдельных товаров в корзине.
Стоимость каждого товара в корзине пользователя сравнивается с заданным в условии ценовым диапазоном. Бонусы и скидки применяются только к тем товарам в корзине, цена которых удовлетворяет условию.
Если вы передаете этот массив, в массиве discounted_items передайте значение null.
Периоды действия акции. Если указано больше одного периода, параметры date_from и date_until становятся обязательными.
Количество погашений по коду.
Ограничивает общее количество купонов.
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promocode/{external_id}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/liveops/v3/project/{project_id}/admin/promocode/{external_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
https://store.xsolla.com/api/v3/project/44056/admin/promocode/coupon_44056_1 \
-H 'Content-Type: application/json' \
-d '{
"attribute_conditions": [
{
"attribute": "account_status",
"can_be_missing": false,
"operator": "eq",
"type": "string",
"value": "golden"
}
],
"discount": {
"percent": "10.10"
},
"name": {
"de-DE": "Neujahrsrabatt",
"en-US": "New Year Discount"
},
"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
}'Персонализированный каталог
Данный API позволяет задавать правила для пользовательских атрибутов. Если пользователь соответствует всем условиям для конкретного правила, будут показаны персонализированные товары.
Узнать о персонализированных акциях можно в подразделе "Скидки" раздела "Акции".
Чтобы передать атрибуты перед покупкой, вы можете использовать API Авторизации Иксолла или передать их в свойство user.attributes при генерации токена с помощью API Платежей Иксолла.