- Удаление акции с купонами
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 проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Условия для проверки атрибутов пользователя. Определяют доступность акции на основе соответствия атрибутов пользователя всем указанным условиям.
Уникальный ID акции. external_id может содержать только строчные и заглавные латинские буквы, цифры, тире и подчеркивания.
Название акции. Данный параметр должен содержать пары ключ/значение, где ключ — это локаль в формате "^[a-z]{2}-[A-Z]{2}$", значение — строка.
Периоды действия акции. Если указано больше одного периода, параметры date_from и date_until становятся обязательными.
Количество погашений по коду.
Ограничивает общее количество купонов.
- https://store.xsolla.com/api/v3/project/{project_id}/admin/coupon
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/liveops/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://store.xsolla.com/api/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
}'{ "external_id": "coupon_external_id" }
Запрос
Удаляет акцию с купонами. Удаленная акция:
- Пропадет из списка акций, настроенных в вашем проекте.
- Не будет применяться к каталогу товаров. Пользователь не сможет получить бонусные товары по этой акции.
После удаления акция не может быть восстановлена. Коды купонов из удаленной акции могут быть добавлены в существующие акции.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
- https://store.xsolla.com/api/v3/project/{project_id}/admin/coupon/{external_id}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/liveops/v3/project/{project_id}/admin/coupon/{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/coupon/coupon_44056_1ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
- https://store.xsolla.com/api/v3/project/{project_id}/admin/coupon/{external_id}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/liveops/v3/project/{project_id}/admin/coupon/{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/coupon/coupon_44056_1Акция с купонами успешно получена.
Условия для проверки атрибутов пользователя. Определяют доступность акции на основе соответствия атрибутов пользователя всем указанным условиям.
Уникальный ID акции. external_id может содержать только строчные и заглавные латинские буквы, цифры, тире и подчеркивания.
Название акции. Данный параметр должен содержать пары ключ/значение, где ключ — это локаль в формате "^[a-z]{2}-[A-Z]{2}$", значение — строка.
Периоды действия акции. Если указано больше одного периода, параметры date_from и date_until становятся обязательными.
Количество погашений по коду.
Ограничивает общее количество купонов.
Ограничивает общее количество купонов, погашаемых одним пользователем.
{ "bonus": [ { … } ], "external_id": "summer20221", "is_enabled": true, "name": { "en-US": "Coupon name", "ru-RU": "Название купона" }, "promotion_periods": [ { … }, { … } ], "redeem_code_limit": null, "redeem_total_limit": 100, "redeem_user_limit": null, "total_limit_state": { "available": 50, "reserved": 10, "used": 40 } }
Персонализированный каталог
Данный API позволяет задавать правила для пользовательских атрибутов. Если пользователь соответствует всем условиям для конкретного правила, будут показаны персонализированные товары.
Узнать о персонализированных акциях можно в подразделе "Скидки" раздела "Акции".
Чтобы передать атрибуты перед покупкой, вы можете использовать API Авторизации Иксолла или передать их в свойство user.attributes при генерации токена с помощью API Платежей Иксолла.