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 Платежей Иксолла.
Запрос
Возвращает цепочки предложений для текущего пользователя.
Все проекты имеют ограничение на количество элементов, возвращаемых в одном ответе. Максимальное значение — 30 элементов на запрос. Чтобы получить больше данных, используйте параметры
limit и offset для пагинации.ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
- https://store.xsolla.com/api/v2/project/{project_id}/user/offer_chain
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/liveops/v2/project/{project_id}/user/offer_chain
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://store.xsolla.com/api/v2/project/44056/user/offer_chain?limit=50&offset=0' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "has_more": false, "items": [ { … }, { … }, { … } ], "total_items_count": 3 }
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
- https://store.xsolla.com/api/v2/project/{project_id}/user/offer_chain/{offer_chain_id}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/liveops/v2/project/{project_id}/user/offer_chain/{offer_chain_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://store.xsolla.com/api/v2/project/44056/user/offer_chain/101 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Цепочка предложений пользователя успешно получена.
Дата окончания срока действия цепочки предложений. Может быть null. Если date_end равен null, цепочка предложений будет бессрочной.
Дата начала действия цепочки предложений.
Номер следующего уровня цепочки предложений. null, если цепочка завершена.
Интервал сброса цепочки предложений.
{ "date_end": "2025-04-25T18:16:00+05:00", "date_start": "2010-04-15T18:16:00+05:00", "description": null, "id": 4, "name": "Offer chain with bundles", "next_step_number": 1, "order": 1, "recurrent_schedule": null, "steps": [ { … }, { … } ] }
Запрос
Завершает прохождение текущим пользователем уровня цепочки предложений и выдает связанную с ним награду.
Используйте этот метод только для бесплатных уровней. Для уровней, доступных за реальную валюту, используйте метод Создание заказа на награду за уровень цепочки предложений.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
- https://store.xsolla.com/api/v2/project/{project_id}/user/offer_chain/{offer_chain_id}/step/number/{step_number}/claim
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/liveops/v2/project/{project_id}/user/offer_chain/{offer_chain_id}/step/number/{step_number}/claim
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://store.xsolla.com/api/v2/project/44056/user/offer_chain/101/step/number/1/claim \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "order_id": 641 }