Перейти к содержимому
/
Погашение кода купона

LiveOps API (2.0.0)

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

LiveOps API предоставляет методы для повышения вовлечённости игроков.

Скачать описание OpenAPI
index.json
index.yaml
Языки
Серверы
Mock server
https://xsolla.redocly.app/_mock/ru/api/liveops/
https://store.xsolla.com/api/

Общие

Операции

Купоны

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

Операции

Получение вознаграждений по купонуClient-side

Запрос

Получает вознаграждения по купону по его коду. Может использоваться, чтобы дать пользователям возможность выбрать один предмет из множества в качестве бонуса. Обычным случаем, если купон содержит игру в качестве бонуса (тип unit), является выбор платформы.

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

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

Пример: 44056
coupon_codestring[ 1 .. 128 ] charactersобязательный

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

Пример: WINTER2021
curl -i -X GET \
  https://xsolla.redocly.app/_mock/ru/api/liveops/v2/project/44056/coupon/code/WINTER2021/rewards \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Ответы

Список вознаграждений по купону успешно получен.

Телоapplication/json
bonusArray of objects(Promotions_200-coupon-bonus-reward)
discountobject or null(Promotions_200-coupon-discount-reward)

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

is_selectableboolean

Если true, то пользователь должен выбрать бонус перед погашением купона.

Ответ
application/json
{
  "bonus": [
    { … },
    { … }
  ],
  "discount": {
    "percent": "10.00"
  },
  "is_selectable": true
}

Погашение кода купонаClient-side

Запрос

Погашает код купона. Пользователь получает бонус после погашения купона.

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

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

Пример: 44056
Телоapplication/json
coupon_codestring[ 1 .. 128 ] characters

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

По умолчанию "WINTER2021"
Пример: "WINTER2021"
selected_unit_itemsobject(Promotions_selected_unit_items)

Награда, выбранная пользователем. Ключ объекта — это артикул юнита, а значение — артикул одного из товаров в юните.

Пример: {"game_1":"game_1_steam","game_2":"game_2_playstation"}
curl -i -X POST \
  https://xsolla.redocly.app/_mock/ru/api/liveops/v2/project/44056/coupon/redeem \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "WINTER2021",
    "selected_unit_items": {
      "game_1": "game_1_steam",
      "game_2": "game_2_playstation"
    }
  }'

Ответы

Купон успешно погашен.

Телоapplication/json
itemsArray of objects
Пример: [{"attributes":[],"description":"Take it, take it all! All of Xsolla's riches in one Mega Booster.","groups":[{"external_id":"powerups","name":"Power Ups"}],"image_url":"https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png","is_free":false,"name":"Xsolla Booster Mega","price":{"amount":"50.0000000000000000","amount_without_discount":"100.0000000000000000","currency":"USD"},"quantity":1,"sku":"com.xsolla.booster_mega_1","type":"virtual_good","virtual_item_type":"consumable","virtual_prices":[]}]
Ответ
application/json
{
  "items": [
    { … }
  ]
}

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

Запрос

Получает список акций с купонами в рамках проекта.

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

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

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

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

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

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

Пример: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/liveops/v3/project/44056/admin/coupon?limit=50&offset=0'

Ответы

Список купонов успешно получен.

Телоapplication/json
active_promotions_countinteger(active_promotions_count)

Количество активных акций.

inactive_promotions_countinteger(inactive_promotions_count)

Количество отключенных акций.

itemsArray of objects(admin-promotions_200-get-coupon-promotion-model)
total_promotions_countinteger(total_promotions_count)

Общее количество акций.

Ответ
application/json
{
  "active_promotions_count": 2,
  "inactive_promotions_count": 0,
  "items": [
    { … },
    { … }
  ],
  "total_promotions_count": 2
}

Промокоды

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

Операции

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

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

Операции

Скидки

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

Операции

Бонусы

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

Операции

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

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

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

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

Операции

Управление

Операции

Admin

Операции

Клиент

Операции

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

Операции

Admin

Операции

Клиент

Операции

Admin

Операции

Клиент

Операции

Admin

Операции

Клиент

Операции