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

Введение

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

Запрос

Удаляет ограничение на количество предзаказа товара.

Pre-Order limit API позволяет продавать товар в ограниченном количестве. Для настройки самого предзаказа перейдите в раздел Admin желаемого товара:

Алиасы для данного эндпоинта:

  • /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}
Безопасность
basicAuth
Путь
project_idintegerобязательный

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

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

Артикул товара.

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

Количество для удаления.

curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 100000
  }'

Ответы

Указанное количество успешно удалено из лимита предзаказа.

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

Получение информации о лимите предзаказа товараServer-sideAdmin

Запрос

Возвращает ограничение на предзаказ товара.

Pre-Order limit API позволяет вам продавать товар в ограниченном количестве. Для настройки самого предварительного заказа перейдите в раздел администратора модуля нужного товара:

Aliases для этой конечной точки:

  • /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}
Безопасность
basicAuth
Путь
project_idintegerобязательный

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

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

Артикул товара.

Пример: booster_mega_1
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1

Ответы

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

Телоapplication/json
availableinteger
Пример: 431
is_pre_order_limit_enabledboolean
Пример: true
item_idinteger
Пример: 1
reservedinteger
Пример: 13
skustring
Пример: "com.xsolla.item_1"
soldinteger
Пример: 556
Ответ
application/json
{ "available": 431, "is_pre_order_limit_enabled": true, "item_id": 1, "reserved": 13, "sku": "com.xsolla.item_1", "sold": 556 }

Увеличение лимита предзаказа товараServer-sideAdmin

Запрос

Добавляет количество к ограничению на предзаказ товара.

Pre-Order limit API позволяет вам продавать товар в ограниченном количестве. Для настройки самого предварительного заказа перейдите в раздел администратора модуля нужного товара:

Aliases для этой конечной точки: */v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}

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

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

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

Артикул товара.

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

Количество для добавления.

curl -i -X POST \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 100000
  }'

Ответы

Указанное количество успешно добавлено к лимиту предзаказа.

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

Catalog

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

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