LiveOps API (2.0.0)
- Версия: 2.0.0
- Серверы:
https://store.xsolla.com/api - Свяжитесь с нами по электронной почте
- Адрес для связи: https://xsolla.com/
- Требуемая версия TLS: 1.2
LiveOps — это набор инструментов для повышения вовлеченности пользователей с помощью акций и персонализированных предложений.
Используйте методы API, чтобы управлять такими возможностями, как:
- Промоакции — создание и управление купонами, промокодами, скидками и бонусными кампаниями.
- Персонализация — возможность задавать условия отображения каталога товаров и применения акций только для определенного круга авторизованных пользователей.
- Лимиты промоакций — настройка ограничений на количество использований акции пользователем, а также периодов автоматического обновления ограничений.
- Цепочки наград и призовые баллы — настройка цепочек наград, привязанных к накоплению призовых баллов.
- Ежедневные цепочки — настройка повторяющихся ежедневных наград для мотивации регулярных входов в игру.
- Цепочки предложений — построение последовательных предложений покупки с ценой на каждом шаге и возможностью бесплатных наград.
- Апселл — способ продаж, при котором пользователю предлагается купить товар с дополнительной ценностью.
Методы API делятся на следующие группы:*
Client — методы для получения доступных промоакций, получения активных цепочек, активации кодов и получения наград от имени аутентифицированных конечных пользователей. Аутентификация выполняется по JWT пользователя.
Персонализированный каталог
Данный API позволяет задавать правила для пользовательских атрибутов. Если пользователь соответствует всем условиям для конкретного правила, будут показаны персонализированные товары.
Узнать о персонализированных акциях можно в подразделе "Скидки" раздела "Акции".
Чтобы передать атрибуты перед покупкой, вы можете использовать API Авторизации Иксолла или передать их в свойство user.attributes при генерации токена с помощью API Платежей Иксолла.
Запрос
Уменьшает оставшееся количество раз, когда указанный пользователь может воспользоваться рекламной акцией в пределах установленного лимита.
API лимитов пользователя позволяет ограничить количество раз, когда пользователи могут использовать рекламную акцию. Для настройки самого лимита перейдите в раздел Admin нужного типа акции:
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Оставшееся количество товаров для продажи или доступных акций для пользователя в пределах установленных ограничений.
- https://store.xsolla.com/api/v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/liveops/v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_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/v2/project/44056/admin/user/limit/promotion/id/111425 \
-H 'Content-Type: application/json' \
-d '{
"available": 1,
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
}'{ "per_user": { "available": 9, "total": 10 } }
Запрос
Возвращает оставшееся количество раз, когда указанный пользователь может воспользоваться акцией в пределах установленного лимита.
API лимитов пользователя позволяет ограничить количество раз, когда пользователи могут использовать рекламную акцию. Для настройки самого лимита перейдите в раздел Admin нужного типа акции:
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
- https://store.xsolla.com/api/v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/liveops/v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_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/v2/project/44056/admin/user/limit/promotion/id/111425?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'{ "per_user": { "available": 9, "total": 10 } }
Запрос
Увеличивает оставшееся количество раз, когда указанный пользователь может воспользоваться акцией в пределах установленного лимита.
API лимитов пользователя позволяет ограничить количество раз, когда пользователи могут использовать рекламную акцию. Для настройки самого лимита перейдите в раздел Admin нужного типа акции:
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Оставшееся количество товаров для продажи или доступных акций для пользователя в пределах установленных ограничений.
- https://store.xsolla.com/api/v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/liveops/v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/user/limit/promotion/id/111425 \
-H 'Content-Type: application/json' \
-d '{
"available": 1,
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
}'{ "per_user": { "available": 9, "total": 10 } }