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

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

Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.

Скачать описание OpenAPI
Языки
Серверы
Mock server
https://xsolla.redocly.app/_mock/ru/api/shop-builder/
https://store.xsolla.com/api/
Операции

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

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

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

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

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

Корзина (на стороне клиента)

Операции

Корзина (на стороне сервера)

Операции

Оплата (на стороне клиента)

Операции

Оплата (на стороне сервера)

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

Catalog

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

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

Купоны

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

Операции

Промокоды

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

Операции

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

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

Операции

Скидки

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

Операции

Бонусы

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

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

Получение цепочки наград текущего пользователяClient-side

Запрос

Метод клиента. Получает цепочки наград текущего пользователя.

Внимание!

Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров в ответе. Чтобы получить больше данных постранично, используйте поля limit и offset.
Безопасность
XsollaLoginUserJWT
Путь
project_idintegerобязательный

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

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

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

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

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

Пример: offset=0
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/user/reward_chain?limit=50&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Ответы

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

Телоapplication/json
has_moreboolean

Используется как индикатор того, что остались еще страницы.

Пример: true
itemsArray of objects(client-reward-chain-item-model)
total_items_countinteger

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

Пример: 10
Ответ
application/json
{ "has_more": false, "items": [ {}, {} ], "total_items_count": 1 }

Получение призовых баллов текущего пользователяClient-side

Запрос

Метод клиента. Возвращает призовые баллы текущего пользователя.

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

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

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

ID цепочки наград.

Пример: 101
curl -i -X GET \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/user/reward_chain/101/balance \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Ответы

Баланс призовых баллов пользователя был успешно восстановлен.

Телоapplication/json
amountinteger

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

descriptionstring or null(value-point-description)

Описание призовых баллов.

image_urlstring(Common_admin-image_url)

URL-адрес изображения.

Пример: "https://image.example.com"
is_clanboolean(is_clan)

Может ли призовой балл использоваться в цепочках наград для клана.

Пример: true
long_descriptionstring or null(value-point-long-description)

Развернутое описание призовых баллов.

namestring(value-point-name)

Название призовых баллов.

skustring(value-point-sku)

Уникальный ID призовых баллов.

Ответ
application/json
{ "amount": 80, "description": "Value points for clan reward system.", "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_clan": true, "long_description": "Value points given to clans to get new rewards in a reward chain.", "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" }

Получение награды на уровнеClient-side

Запрос

Метод клиента. Запрашивает награду на уровне для текущего пользователя в цепочке наград.

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

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

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

ID цепочки наград.

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

ID уровня цепочки наград.

Пример: 120
curl -i -X POST \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/user/reward_chain/101/step/120/claim \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Ответы

Успешно получена награда на уровне для текущего пользователя в цепочке наград.

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