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

Введение

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/
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции

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

Операции

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

Запрос

Возвращает корзину текущего пользователя.

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

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

Пример: 44056
Запрос
currencystring

Валюта, в которой указаны цены товаров в корзине. Трехбуквенный код валюты в соответствии с ISO 4217. Подробную информацию о валютах, поддерживаемых Xsolla, смотрите в документации.

По умолчанию "USD"
localestring

Язык ответа. Двухбуквенный код языка в нижнем регистре в соответствии с ISO 639-1.

По умолчанию "en"
curl -i -X GET \
  'https://store.xsolla.com/api/v2/project/44056/cart?currency=USD&locale=en' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Ответы

Корзина с товарами успешно возвращена.

Телоapplication/json
cart_idstring

ID корзины.

Пример: "cart_id"
is_freeboolean(value-cart_is_free)

Если true, корзина бесплатная.

По умолчанию false
Пример: false
itemsArray of objects
priceobject or null

Цена корзины.

Пример: {"amount":"6150.0000000000000000","amount_without_discount":"6150.0000000000000000","currency":"USD"}
promotionsArray of objects(Catalog_cart_promotions)

Примененные ко всей корзине акции. Массив возвращается, если:

  • Акция влияет на общую стоимость корзины при использовании промокода с настройкой Скидка на покупку.

  • К корзине добавляются бонусные товары.

Если акции на уровне заказа не применялись, возвращается пустой массив.

Ответ
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ {} ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "promotions": [ {} ] }

Удаление всех товаров из текущей корзиныClient-side

Запрос

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

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

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

Пример: 44056
curl -i -X PUT \
  https://store.xsolla.com/api/v2/project/44056/cart/clear \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Ответы

Корзина успешно очищена.

Наполнение корзины товарамиClient-side

Запрос

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

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

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

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

Список товаров.

Пример: [{"quantity":123,"sku":"com.xsolla.booster_mega_1"}]
items[].​quantitynumberобязательный
По умолчанию 123
items[].​skustringобязательный
По умолчанию "booster_mega_1"
curl -i -X PUT \
  https://store.xsolla.com/api/v2/project/44056/cart/fill \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "items": [
      {
        "quantity": 123,
        "sku": "com.xsolla.booster_mega_1"
      }
    ]
  }'

Ответы

Корзина с товарами успешно возвращена.

Телоapplication/json
cart_idstring

ID корзины.

Пример: "cart_id"
is_freeboolean(value-cart_is_free)

Если true, корзина бесплатная.

По умолчанию false
Пример: false
itemsArray of objects
priceobject or null

Цена корзины.

Пример: {"amount":"6150.0000000000000000","amount_without_discount":"6150.0000000000000000","currency":"USD"}
promotionsArray of objects(Catalog_cart_promotions)

Примененные ко всей корзине акции. Массив возвращается, если:

  • Акция влияет на общую стоимость корзины при использовании промокода с настройкой Скидка на покупку.

  • К корзине добавляются бонусные товары.

Если акции на уровне заказа не применялись, возвращается пустой массив.

warningsArray of objects
Ответ
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ {} ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "promotions": [ {} ], "warnings": [ {} ] }

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

Операции

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

Операции

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

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

Catalog

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

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