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

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 Платежей Иксолла.

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

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

Операции

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

Операции

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

Операции

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

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

Получение информации о настройках вебхуковServer-sideAdmin

Запрос

Получает информацию о настройках вебхуков в Store. Подробная информация о настройке вебхуков приведена в документации.

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

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

Пример: 44056
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/webhook

Ответы

Информация о настройках вебхуков успешно получена.

Телоapplication/json
is_enabledboolean
Пример: true
secretstring
Пример: "my_secret"
urlstring
Пример: "http://site.ru/webhook"
Ответ
application/json
{ "is_enabled": true, "secret": "my_secret", "url": "http://site.ru/webhook" }

Обновление информации о настройках вебхуковServer-sideAdmin

Запрос

Обновляет информацию о настройках вебхуков в Store. Подробная информация о настройке вебхуков приведена в документации.

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

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

Пример: 44056
Телоapplication/jsonобязательный

Информация о настройках вебхуков.

is_enabledbooleanобязательный

Подключено ли получение вебхуков раздела Игровые сервисы.

Для вебхуков раздела Игровые сервисы настройка, заданная в этом методе, имеет приоритет над настройкой, указанной в Личном кабинете в разделе Настройки проекта > Вебхуки.

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

Секретный ключ проекта для подписи вебхуков раздела Игровые сервисы.

Для вебхуков раздела Игровые сервисы ключ, заданный в этом методе, имеет приоритет над ключом, сгенерированным в Личном кабинете в разделе Настройки проекта > Вебхуки.

Пример: "my_secret_key"
urlstringобязательный

URL-адрес вашего сервера для получения вебхуков раздела Игровые сервисы. URL-адрес должен быть общедоступным и использовать протокол HTTPS, например https://example.com. Вы также можете ввести URL-адрес из любого инструмента для тестирования вебхуков.

Для вебхуков раздела Игровые сервисы настройка, заданная в этом методе, имеет приоритет над настройкой, указанной в Личном кабинете в разделе Настройки проекта > Вебхуки.

Пример: "http://site.ru/webhook"
versioninteger

Версия вебхуков. В версии 2 в массиве items добавлены параметры is_free, is_bonus и is_bundle_content. В версии 1 (по умолчанию) эти параметры отсутствуют.

Перечисление12
Пример: 1
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/shop-builder/v2/project/44056/admin/webhook \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "secret": "my_secret_key",
    "url": "http://site.ru/webhook",
    "version": 1
  }'

Ответы

Информация о настройках вебхуков успешно обновлена.

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

Catalog

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

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

Купоны

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

Операции

Промокоды

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

Операции

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

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

Операции

Скидки

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

Операции

Бонусы

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

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