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

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`. Например, при вызове метода с параметрами `limit = 25` и `offset = 100` вернется 25 элементов, начиная со 101-го в общем списке.
Безопасность
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/daily_chain?limit=50&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Ответы

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

Телоapplication/json
has_moreboolean

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

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

Общее количество ежедневных наград.

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

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

Запрос

Клиентский метод. Возвращает ежедневную награду по ее ID для текущего пользователя.

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

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

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

ID ежедневной награды.

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

Ответы

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

Телоapplication/json
date_startstring(date-time)(calendar_hard_date_start)

Дата, когда начнет действовать ежедневная награда.

Пример: "2020-04-15T18:16:00+05:00"
is_recurrentboolean(calendar_hard_is_recurrent)

Перезапускается ли ежедневная награда. Если передано значение true, ежедневная награда автоматически сбрасывается в конце периода ее действия. Следующие значения для параметров start_date и end_date рассчитываются исходя из количества уровней ежедневной награды и времени старта ежедневной награды, заданном в параметре start_date.

По умолчанию false
Пример: true
typestring

Тип ежедневной награды, который определяет, когда пользователи могут получать награды.

Перечисление ЗначениеОписание
calendar_hard

Разблокирует следующий уровень наград каждые 24 часа. Неполученные награды становятся недоступны, как только открывается награда за следующий уровень.

rolling_skippable

Разблокирует награду за следующий уровень каждые 24 часа, отсчет начинается со значения, указанного в параметре date_start. Прогресс последовательный: новая награда не откроется, пока не будет получена предыдущая. Если пользователь пропустил один или несколько дней, Если пользователь пропускает один или несколько дней, он продолжает с того уровня, где остановился; за пропущенные дни награды не полагаются.

rolling_unskippable

Разблокирует награду за следующий уровень каждые 24 часа, отсчет начинается со значения, указанного в параметре date_start. Прогресс последовательный: новая награда не откроется, пока не будет получена предыдущая. Если пользователь пропустил день, его прогресс сбрасывается и он начинает заново с первого уровня.

Дискриминатор
date_endstring or null(date-time)(daily_chain_date_end)

Дата окончания срока действия ежедневных наград. Может быть null. При установке типа calendar_hard эта дата будет автоматически рассчитана по количеству добавленных уровней, поэтому можно оставить значение null.

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

Описание ежедневной награды.

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

ID ежедневной награды.

Пример: 9
namestring

Название ежедневной награды.

Пример: "Weekly quest"
orderinteger(order)

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

Пример: 1
stepsArray of objects(client-daily-chain-step-model)
Ответ
application/json
{ "date_end": "2025-04-03T18:16:00+05:00", "date_start": "2025-04-01T18:16:00+05:00", "description": "Active daily reward description", "id": 101, "name": "Active daily reward", "order": 1, "steps": [ {}, {}, {}, {} ], "type": "calendar_hard" }

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

Запрос

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

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

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

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

ID ежедневной награды.

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

Номер уровня ежедневной награды.

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

Ответы

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

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