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

Введение

API каталога позволяет настраивать каталог внутриигровых товаров на стороне Xsolla и отображать каталог пользователям в вашем игровом магазине.

API позволяет вам управлять такими сущностями каталога, как:

  • Виртуальные предметы — внутриигровые предметы, например оружие, скины, бустеры.
  • Виртуальная валюта — виртуальные деньги, которые используются для приобретения виртуальных товаров. Пакеты виртуальной валюты — предустановленные наборы виртуальной валюты.
  • Бандлы — комбинированные наборы виртуальных предметов, валюты или игровых ключей, продаваемые как единый артикул.
  • Игровые ключи — ключи для игр и DLC, распространяемые через такие платформы, как Steam, или других DRM-провайдеров.
  • Группы — логические группировки для организации и сортировки товаров в каталоге.

Методы API

Методы API делятся на следующие группы:

  • Admin — методы для создания, обновления, удаления и настройки товаров и групп каталога. Для вызова требуется базовая HTTP-аутентификация с использованием учетных данных Личного кабинета. Не предназначены для построения витрин для конечных пользователей.
  • Catalog — методы для получения товаров и построения витрин для конечных пользователей. Поддерживают опциональную аутентификацию с использованием JWT пользователя для возврата персонализированных данных, таких как пользовательские лимиты и активные промоакции.
Скачать описание OpenAPI
Языки
Серверы
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/ru/api/catalog/
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции

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

Операции

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

Операции

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

Операции

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

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

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

Запрос

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

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

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

Пример: 44056
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/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://store.xsolla.com/api/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 позволяет получать продаваемые товары любого вида или конкретный товар.

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