Перейти к содержимому

Введение

LiveOps — это набор инструментов для повышения вовлеченности пользователей с помощью акций и персонализированных предложений.

Используйте методы API, чтобы управлять такими возможностями, как:

  • Промоакции — создание и управление купонами, промокодами, скидками и бонусными кампаниями.
  • Персонализация — возможность задавать условия отображения каталога товаров и применения акций только для определенного круга авторизованных пользователей.
  • Лимиты промоакций — настройка ограничений на количество использований акции пользователем, а также периодов автоматического обновления ограничений.
  • Цепочки наград и призовые баллы — настройка цепочек наград, привязанных к накоплению призовых баллов.
  • Ежедневные цепочки — настройка повторяющихся ежедневных наград для мотивации регулярных входов в игру.
  • Цепочки предложений — построение последовательных предложений покупки с ценой на каждом шаге и возможностью бесплатных наград.
  • Апселл — способ продаж, при котором пользователю предлагается купить товар с дополнительной ценностью.

Методы API

Методы API делятся на следующие группы:* Admin — методы для создания, обновления, активации и удаления кампаний и конфигураций цепочек. Для вызова требуется базовая HTTP-аутентификация с использованием учетных данных Личного кабинета.

  • Client — методы для получения доступных промоакций, получения активных цепочек, активации кодов и получения наград от имени аутентифицированных конечных пользователей. Аутентификация выполняется по JWT пользователя.
Скачать описание OpenAPI
Языки
Серверы
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/ru/api/liveops/
Операции

Купоны

Этот API позволяет вам управлять купонами.

Операции

Промокоды

Этот API позволяет вам управлять промокодами.

Операции

Активация акции с промокодамиServer-sideAdmin

Запрос

Активирует акцию с промокодами.

После создания акция с промокодами по умолчанию отключена. Погашение по акции не будет доступно, пока вы ее не активируете. Используйте данный метод, чтобы включить и активировать акцию с промокодами.

Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

Пример: 44056
external_idintegerобязательный

External ID акции. Уникальный идентификатор акции в рамках проекта.

Пример: coupon_44056_1
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/promocode/coupon_44056_1/activate

Ответы

Промокод успешно активирован.

Ответ
Нет содержимого

Получение кодов акции с промокодамиServer-sideAdmin

Запрос

Получает коды акции с промокодами.

Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

Пример: 44056
external_idintegerобязательный

External ID акции. Уникальный идентификатор акции в рамках проекта.

Пример: coupon_44056_1
Запрос
limitinteger>= 1

Лимит количества элементов на странице.

Пример: limit=50
offsetinteger>= 0

Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).

Пример: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/promocode/coupon_44056_1/code?limit=50&offset=0'

Ответы

Список кодов для промокода успешно получен.

Телоapplication/json
codesArray of objects
total_countnumber

Общее количество кодов для промокода.

Ответ
application/json
{ "codes": [ {}, {}, {}, {}, {} ], "total_count": 5 }

Создание кода для акции с промокодамиServer-sideAdmin

Запрос

Создает код для акции с промокодами.

Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

Пример: 44056
external_idintegerобязательный

External ID акции. Уникальный идентификатор акции в рамках проекта.

Пример: coupon_44056_1
Телоapplication/json
coupon_codestring(Promotions_coupon_code)[ 1 .. 128 ] characters^[a-zA-Z0-9]+$

Уникальный код, чувствительный к регистру. Содержит буквы и цифры.

По умолчанию "WINTER2021"
Пример: "WINTER2021"
curl -i -X POST \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/promocode/coupon_44056_1/code \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "WINTER2021"
  }'

Ответы

Код успешно создан.

Телоapplication/json
codestring(Promotions_coupon_code)[ 1 .. 128 ] characters^[a-zA-Z0-9]+$

Уникальный код, чувствительный к регистру. Содержит буквы и цифры.

По умолчанию "WINTER2021"
Пример: "WINTER2021"
Ответ
application/json
{ "code": "WINTER2021" }

Уникальный каталог предложений

Этот API позволяет вам управлять уникальными предложениями каталога.

Операции

Скидки

Этот API позволяет вам управлять скидочными акциями.

Операции

Бонусы

Этот API позволяет вам управлять бонусными акциями.

Операции

Персонализированный каталог

Данный API позволяет задавать правила для пользовательских атрибутов. Если пользователь соответствует всем условиям для конкретного правила, будут показаны персонализированные товары.

Узнать о персонализированных акциях можно в подразделе "Скидки" раздела "Акции".

Чтобы передать атрибуты перед покупкой, вы можете использовать API Авторизации Иксолла или передать их в свойство user.attributes при генерации токена с помощью API Платежей Иксолла.

Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции