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/promotion/{promotion_id}/item
- Mock serverhttps://xsolla.redocly.app/_mock/ru/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 GET \
-u <username>:<password> \
https://store.xsolla.com/api/v3/project/44056/admin/promotion/111425/itemАкция со скидками успешно получена.
Условия для проверки атрибутов пользователя. Определяют доступность акции на основе соответствия атрибутов пользователя всем указанным условиям.
Список акций, которые исключаются при применении этой акции.
Example: [12, 789]
Название акции. Данный параметр должен содержать пары ключ/значение, где ключ — это локаль в формате "^[a-z]{2}-[A-Z]{2}$", значение — строка.
Массив объектов с условиями, задающими ценовой диапазон применения акции.
Акция применяется только к товарам, цена которых удовлетворяет всем условиям в массиве. Если вы передаете этот массив, в объекте items передайте значение null.
{ "discount": { "percent": "20.00" }, "excluded_promotions": [ 23, 45 ], "id": 1, "is_enabled": true, "items": [ { … }, { … } ], "limits": { "per_item": null, "per_user": { … }, "recurrent_schedule": { … } }, "name": { "en-US": "Promotion", "ru-RU": "Акция" }, "price_conditions": [ { … }, { … } ], "promotion_periods": [ { … } ] }
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Объект с данными акции.
Условия для проверки атрибутов пользователя. Определяют доступность акции на основе соответствия атрибутов пользователя всем указанным условиям.
Список акций, которые исключаются при применении этой акции.
Example: [12, 789]
Название акции. Данный параметр должен содержать пары ключ/значение, где ключ — это локаль в формате "^[a-z]{2}-[A-Z]{2}$", значение — строка.
Массив объектов с условиями, задающими ценовой диапазон применения акции.
Акция применяется только к товарам, цена которых удовлетворяет всем условиям в массиве. Если вы передаете этот массив, в объекте items передайте значение null.
- https://store.xsolla.com/api/v3/project/{project_id}/admin/promotion/{promotion_id}/item
- Mock serverhttps://xsolla.redocly.app/_mock/ru/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 PUT \
-u <username>:<password> \
https://store.xsolla.com/api/v3/project/44056/admin/promotion/111425/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"
}
]
}'Персонализированный каталог
Данный API позволяет задавать правила для пользовательских атрибутов. Если пользователь соответствует всем условиям для конкретного правила, будут показаны персонализированные товары.
Узнать о персонализированных акциях можно в подразделе "Скидки" раздела "Акции".
Чтобы передать атрибуты перед покупкой, вы можете использовать API Авторизации Иксолла или передать их в свойство user.attributes при генерации токена с помощью API Платежей Иксолла.