Перейти к содержимому
/
Получение списка товаров...

LiveOps API (2.0.0)

Введение

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

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

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

Методы API

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

  • Client — методы для получения доступных промоакций, получения активных цепочек, активации кодов и получения наград от имени аутентифицированных конечных пользователей. Аутентификация выполняется по JWT пользователя.
Скачать описание OpenAPI
index.json
index.yaml
Языки
Серверы
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 Платежей Иксолла.

Операции

Управление

Операции

Admin

Операции

Удаление призовых баллов с товаровServer-sideAdmin

Запрос

Удаляет призовые баллы со ВСЕХ товаров.

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

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

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

Value Point SKU.

Пример: value_point_3
curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/value_point_3/value_points/rewards

Ответы

Призовые баллы для товаров были успешно удалены.

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

Получение списка товаров с призовыми балламиServer-sideAdmin

Запрос

Получает список всех товаров с призовыми баллами для проекта администрирования.

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

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

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

Value Point SKU.

Пример: value_point_3
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/value_point_3/value_points/rewards

Ответы

Список товаров с призовыми баллами был успешно получен.

Телоapplication/json
itemsArray of objects(admin-item-value-point-reward)
Ответ
application/json
{
  "items": [
    { … },
    { … }
  ]
}

Частичное обновление призовых баллов для товаров Server-sideAdmin

Запрос

Частично обновляет количество призовых баллов для одного или нескольких товаров по артикулам этих товаров. Пользователи получают призовые баллы после покупки этих товаров.

Принципы обновления призовых баллов:

  • Если у товара еще нет призовых баллов, отправка ненулевого значения в поле amount создаст их.
  • Если у товара уже есть призовые баллы, отправка ненулевого значения в поле amount обновит их.
  • Если в поле amount передано значение 0, существующие призовые баллы для этого товара будут удалены.

В отличие от метода PUT (Настройка призовых баллов для товаров), этот метод PATCH не перезаписывает все ранее установленные призовые баллы для товаров в проекте, а обновляет только указанные.

В одном запросе можно обновить до 100 товаров. В одном запросе нельзя передавать одинаковые артикулы товаров.

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

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

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

Value Point SKU.

Пример: value_point_3
Телоapplication/jsonArray [
amountinteger>= 0обязательный

Количество призовых баллов.

skustring(sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$обязательный

Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.

Пример: "booster_mega_1"
]
curl -i -X PATCH \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/value_point_3/value_points/rewards \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "amount": 100,
      "sku": "booster_1"
    },
    {
      "amount": 0,
      "sku": "booster_mega"
    }
  ]'

Ответы

Призовые баллы для товаров были успешно обновлены.

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

Клиент

Операции

Клиент кланов

Операции

Admin

Операции

Клиент

Операции

Admin

Операции

Клиент

Операции

Admin

Операции

Клиент

Операции