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

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

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

Получение 10 участников, внесших наибольший вклад в продвижение по клановой цепочке наградClient-side

Запрос

Возвращает 10 участников, внесших наибольший вклад в определенную цепочку наград для текущего клана пользователя. Если пользователь не состоит в клане, в ответе вернется пустой массив.

Безопасность
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/clan/contributors/101/top \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Ответы

10 участников, внесших наибольший вклад в клановую цепочку наград.

Телоapplication/jsonArray [
contributed_amountinteger

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

Пример: 100
namestring

ID пользователя, который отправляется в Xsolla в процессе авторизации и связывает пользователя с вашим проектом Xsolla Login.

Пример: "Rocket"
]
Ответ
application/json
[ { "contributed_amount": 555, "name": "winner" }, { "contributed_amount": 398, "name": "Rocket" }, { "contributed_amount": 201, "name": "MrJoe" }, { "contributed_amount": 1, "name": "beginner" } ]

Обновление клана текущего пользователяClient-side

Запрос

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

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

ID проекта.

По умолчанию 44056
curl -i -X PUT \
  'https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/{project_id}/user/clan/update' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Ответы

Клан пользователя был успешно обновлен.

Телоapplication/json
rewardArray of objects
Ответ
application/json
{ "reward": [ {}, {} ] }
Операции
Операции
Операции
Операции
Операции
Операции
Операции