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

Введение

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 позволяет вам управлять промокодами.

Операции

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

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

Операции

Скидки

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

Операции

Бонусы

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

Операции

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

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

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

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

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

Создание апселлаServer-sideAdmin

Запрос

Создает апселл в проекте.

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

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

Пример: 44056
Телоapplication/json
One of:

Тип апселла.

is_enabledboolean(is_enabled)обязательный
Пример: true
itemsArray of stringsобязательный

Массив артикулов товаров

По умолчанию null
Пример: ["game_sku"]
typestringобязательный
Значение"fixed_list"
Пример: true
curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "items": [
      "game_sku_1",
      "game_sku_2",
      "game_sku_3"
    ],
    "type": "fixed_list"
  }'

Ответы

Апселл создан в проекте.

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

Обновление апселлаServer-sideAdmin

Запрос

Обновляет апселл в проекте.

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

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

Пример: 44056
Телоapplication/json
One of:

Тип апселла.

is_enabledboolean(is_enabled)обязательный
Пример: true
itemsArray of stringsобязательный

Массив артикулов товаров

По умолчанию null
Пример: ["game_sku"]
typestringобязательный
Значение"fixed_list"
Пример: true
curl -i -X PUT \
  https://store.xsolla.com/api/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "items": [
      "game_sku_1",
      "game_sku_2",
      "game_sku_3"
    ],
    "type": "fixed_list"
  }'

Ответы

Апселл обновлен в проекте.

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

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

Запрос

Меняет статус апселла в проекте: активирует или деактивирует.

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

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

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

Статус активации.

Пример: activate
curl -i -X PUT \
  https://store.xsolla.com/api/v2/project/44056/admin/items/upsell/activate \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Ответы

Апселл в проекте был активирован или деактивирован.

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