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

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

Запрос

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

Внимание

Все проекты имеют ограничение на количество элементов, возвращаемых в одном ответе. Максимальное значение — 30 элементов на запрос. Чтобы получить больше данных, используйте параметры 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/offer_chain?limit=50&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Ответы

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

Телоapplication/json
has_moreboolean

Показывает, доступны ли другие страницы.

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

Общее количество доступных цепочек предложений.

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

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

Запрос

Возвращает цепочку предложений по ее ID для текущего пользователя.

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

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

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

ID цепочки предложений.

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

Ответы

Цепочка предложений пользователя успешно получена.

Телоapplication/json
date_endstring or null(date-time)(offer_chain_date_end)

Дата окончания срока действия цепочки предложений. Может быть null. Если date_end равен null, цепочка предложений будет бессрочной.

Пример: "2020-04-15T18:16:00+05:00"
date_startstring(date-time)(offer_chain_date_start)

Дата начала действия цепочки предложений.

Пример: "2020-04-15T18:16:00+05:00"
descriptionstring or null

Описание цепочки предложений.

Пример: "Major weekly quest"
idinteger

ID цепочки предложений.

Пример: 9
namestring

Название цепочки предложений.

Пример: "Weekly quest"
next_step_numberinteger or null

Номер следующего уровня цепочки предложений. null, если цепочка завершена.

Пример: 1
orderinteger(order)

Определяет порядок расположения.

Пример: 1
recurrent_scheduleobject or null(offer_chain_recurrent_schedule_client_side)

Интервал сброса цепочки предложений.

stepsArray of objects(client-offer-chain-step-model)
Ответ
application/json
{ "date_end": "2025-04-25T18:16:00+05:00", "date_start": "2010-04-15T18:16:00+05:00", "description": null, "id": 4, "name": "Offer chain with bundles", "next_step_number": 1, "order": 1, "recurrent_schedule": null, "steps": [ {}, {} ] }

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

Запрос

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

Внимание

Используйте этот метод только для бесплатных уровней. Для уровней, доступных за реальную валюту, используйте метод Создание заказа на награду за уровень цепочки предложений.
Безопасность
XsollaLoginUserJWT
Путь
project_idintegerобязательный

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

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

ID цепочки предложений.

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

Номер уровня в цепочке предложений.

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

Ответы

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

Телоapplication/json
order_idinteger

ID заказа.

Ответ
application/json
{ "order_id": 641 }
Операции
Операции
Операции
Операции
Операции