Additional fields to include in the response. By default, these fields are not returned. Pass the required values to include them.
- Получение списка пакетов виртуальных валют по указанной группе
Получение списка виртуальных предметов
Получение виртуального предмета по артикулу
Получение списка всех виртуальных предметов
Получение списка виртуальных валют
Получение виртуальной валюты по артукулу
Получение списка пакетов виртуальной валюты
Получение пакета виртуальной валюты по артикулу
Получение списка товаров по указанной группе
Получение списка виртуальных валют по указанной группе
Получение списка пакетов...
Catalog API (2.0.0)
- Версия: 2.0.0
- Серверы:
https://store.xsolla.com/api - Свяжитесь с нами по электронной почте
- URL для связи: https://xsolla.com/
- Требуемая версия TLS: 1.2
API каталога позволяет настраивать каталог внутриигровых товаров на стороне Xsolla и отображать каталог пользователям в вашем игровом магазине.
API позволяет вам управлять такими сущностями каталога, как:
- Виртуальные предметы — внутриигровые предметы, например оружие, скины, бустеры.
- Виртуальная валюта — виртуальные деньги, которые используются для приобретения виртуальных товаров. Пакеты виртуальной валюты — предустановленные наборы виртуальной валюты.
- Бандлы — комбинированные наборы виртуальных предметов, валюты или игровых ключей, продаваемые как единый артикул.
- Игровые ключи — ключи для игр и DLC, распространяемые через такие платформы, как Steam, или других DRM-провайдеров.
- Группы — логические группировки для организации и сортировки товаров в каталоге.
Методы API делятся на следующие группы:
Admin — методы для создания, обновления, удаления и настройки товаров и групп каталога. Для вызова требуется базовая HTTP-аутентификация с использованием учетных данных Личного кабинета. Не предназначены для построения витрин для конечных пользователей.Catalog — методы для получения товаров и построения витрин для конечных пользователей. Поддерживают опциональную аутентификацию с использованием JWT пользователя для возврата персонализированных данных, таких как пользовательские лимиты и активные промоакции.
Методы API требуют аутентификации либо от имени пользователя, либо от имени проекта. Тип используемой схемы аутентификации указан в блоке Безопасность в описании каждого метода.
Аутентификация с помощью JWT пользователя применяется, когда запрос выполняется из браузера, мобильного приложения или игры. По умолчанию используется XsollaLoginUserJWT. Подробная информация о создании токена приведена в документации Xsolla Login API.
Токен передается в заголовке Authorization в следующем формате: Authorization: Bearer <user_JWT>, где <user_JWT> — токен пользователя. Токен идентифицирует пользователя и обеспечивает доступ к персонализированным данным.
В качестве альтернативы вы можете использовать токен для открытия платежного интерфейса.
Базовая HTTP-аутентификация применяется при взаимодействии server-to-server, когда вызов API отправляется напрямую с вашего сервера, а не из браузера пользователя или мобильного приложения. Обычно применяется базовая HTTP-аутентификация с использованием ключа API.
Примечание
Ключ API является конфиденциальным и не должен храниться или использоваться в клиентских приложениях.
Ключ API является конфиденциальным и не должен храниться или использоваться в клиентских приложениях.
При базовой серверной аутентификации все запросы к API должны содержать заголовок:
- для
basicAuth—Authorization: Basic <your_authorization_basic_key>, гдеyour_authorization_basic_key— это параproject_id:api_key, закодированная по стандарту Base64; - для
basicMerchantAuth—Authorization: Basic <your_authorization_basic_key>, гдеyour_authorization_basic_key— это параmerchant_id:api_key, закодированная по стандарту Base64.
Значения параметров вы можете найти в Личном кабинете:
merchant_idотображается:- В разделе Настройки компании > Компания.
- В адресной строке браузера на любой странице Личного кабинета. URL-адрес имеет вид:
https://publisher.xsolla.com/<merchant_id>.
project_idотображается:- В Личном кабинете рядом с названием проекта.
- В адресной строке браузера при работе с проектом в Личном кабинете. URL-адрес имеет вид:
https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.
api_keyотображается в Личном кабинете только при создании и должен храниться на вашей стороне. Создать ключ можно в разделах:
Внимание
Если необходимый метод API не включает в себя path-параметр
Если необходимый метод API не включает в себя path-параметр
project_id, используйте для авторизации ключ API, который действует во всех проектах.Подробная информация о работе с ключами API приведена в справочнике API.
Для продажи корзины используется схема аутентификации AuthForCart, которая поддерживает два режима:
Аутентификация с помощью JWT пользователя. Токен передается в заголовке
Authorizationв следующем формате:Authorization: Bearer <user_JWT>, где<user_JWT>— токен пользователя. Токен идентифицирует пользователя и обеспечивает доступ к персонализированным данным. В качестве альтернативы вы можете использовать токен для открытия платежного интерфейса.Упрощенный режим без заголовка. Он применяется только для неавторизованных пользователей и может быть использована только для продажи игровых ключей. Вместо токена в запрос передаются заголовки:
x-unauthorized-idс ID запроса;x-userс email пользователя, закодированным в формате Base64.
Товары всех типов (виртуальные предметы, бандлы, виртуальная валюта, ключи) используют схожую структуру данных. Понимание базовой структуры упрощает работу с API и позволяет быстрее ориентироваться в документации.
Примечание
В некоторых методах могут использоваться дополнительные поля, но они не изменяют базовую структуру.
В некоторых методах могут использоваться дополнительные поля, но они не изменяют базовую структуру.
Идентификация
merchant_id— ID компании в Личном кабинете;project_id— ID проекта в Личном кабинете;sku— артикул товара, уникальный в рамках проекта.
Отображение в каталоге
name— название;description— описание;image_url— ссылка на изображение;is_enabled— доступность товара;is_show_in_store— отображение в каталоге.
Подробнее об управлении доступностью товаров в каталоге – в документации.
Организация
type— тип товара, например, виртуальный предмет (virtual_item) или бандл (bundle);groups— группы, к которым относится товар;order— порядок отображения в каталоге.
Условия продажи
prices— цены в реальной или виртуальной валюте;limits— ограничения на покупку;periods— период доступности;regions— региональные ограничения.
Пример базовой структуры:
{
"attributes": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://.../image.png",
"name": {
"en": "Crystals",
"de": "Kristalle"
},
"quantity": 500,
"sku": "com.xsolla.crystal_2",
"type": "virtual_currency"
}
],
"description": {
"en": "Crystals x500"
},
"groups": [],
"image_url": "https://.../image.png",
"is_enabled": true,
"is_free": false,
"is_show_in_store": true,
"limits": {
"per_item": null,
"per_user": null,
"recurrent_schedule": null
},
"long_description": null,
"media_list": [],
"name": {
"en": "Medium crystal pack"
},
"order": 1,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"prices": [
{
"amount": 20,
"country_iso": "US",
"currency": "USD",
"is_default": true,
"is_enabled": true
}
],
"regions": [],
"sku": "com.xsolla.crystal_pack_2",
"type": "bundle",
"vc_prices": []
}Xsolla API позволяет реализовать логику магазина внутриигровых товаров, включая получение каталога, управление корзиной, создание заказов и отслеживание их статусов. В зависимости от сценария интеграции методы API делятся на подразделы Admin и Catalog, которые используют разные схемы аутентификации.
Ниже приведен пример базового сценария настройки и работы магазина — от создания товаров до их продажи пользователю.
Создайте каталог товаров для вашего магазина, например, виртуальные предметы, бандлы или виртуальную валюту.
Примеры методов:
Настройте инструменты привлечения пользователей и монетизации, например скидки, бонусы, ежедневные награды или цепочки предложений.
Примеры методов:
Настройте отображение товаров магазина в вашем приложении.
Внимание
Не используйте методы подраздела Admin для построения каталога пользователям — у таких методов заданы ограничения по частоте запросов, которые не рассчитаны на пользовательский трафик.
Не используйте методы подраздела Admin для построения каталога пользователям — у таких методов заданы ограничения по частоте запросов, которые не рассчитаны на пользовательский трафик.
Примеры методов:
Примечание
По умолчанию в методах получения каталога возвращаются товары, которые отображаются в магазине на момент запроса. Чтобы получить информацию о товарах, период отображения которых еще не наступил или уже истек, передайте параметр
По умолчанию в методах получения каталога возвращаются товары, которые отображаются в магазине на момент запроса. Чтобы получить информацию о товарах, период отображения которых еще не наступил или уже истек, передайте параметр
"show_inactive_time_limited_items": 1 при запросе каталога.
Вы можете продавать товары за реальную валюту следующими способами:
- Быстрая покупка — продажа одного товара, но в любом количестве.
- Покупка корзины — пользователь наполняет корзину, добавляет и удаляет товары, изменяет количество в одном заказе.
Если товар оплачивается внутриигровой валютой, а не реальными деньгами, используйте метод Создание заказа с указанным товаром, приобретенным за виртуальную валюту. Платежный интерфейс открывать не нужно — списание происходит в момент вызова метода.
Если товар бесплатный, используйте метод Создание заказа с указанным бесплатным товаром или метод Создание заказа с помощью бесплатной корзины. Платежный интерфейс открывать не нужно — заказ сразу переходит в статус done.
Используйте клиентский метод создания заказа с указанным товаром – в ответе вы получите токен, который используется для открытия платежного интерфейса.
Примечание
Информация о скидке доступна пользователю только в платежном интерфейсе. Использование промокодов не предусмотрено.
Информация о скидке доступна пользователю только в платежном интерфейсе. Использование промокодов не предусмотрено.
Наполнение и покупка корзины может осуществляться на клиенте или на сервере.
Наполнение и покупка корзины на клиенте
Самостоятельно реализуйте логику добавления и удаления товаров. Также необходимо учитывать, что до вызова метода наполнения корзины у вас не будет информации о том, какие акции будут применены при покупке. Это означает, что итоговая стоимость и сведения о добавленных бонусных предметах будут неизвестны.
Реализуйте следующую логику работы с корзиной:
- После наполнения корзины игроком используйте метод Наполнение корзины товарами для наполнения корзины. В ответе вернется текущая информация о выбранных товарах — цены до и после применения скидок, бонусные товары.
- Обновите содержимое корзины в соответствии с действиями пользователя:
- Для добавления товара или изменения его количества используйте метод Обновление товара в корзине по ID корзины.
- Для удаления товара используйте метод Удаление товара из корзины по ID корзины.
Примечание
Если вы хотите получить актуальное состояние корзины, используйте метод Получение корзины текущего пользователя.
Если вы хотите получить актуальное состояние корзины, используйте метод Получение корзины текущего пользователя.
- Используйте метод покупки корзины Создание заказа со всеми товарами из текущей корзины. В ответе вернутся ID заказа и платежный токен. Заказу будет присвоен статус
new.
Наполнение и покупка корзины на сервере
Этот вариант наполнения корзины может занимать значительное время на настройку, поскольку каждое изменение корзины может сопровождаться вызовом большего количества методов API.
Реализуйте следующую логику работы с корзиной:
- После наполнения корзины игроком используйте методс Наполнение корзины товарамидля наполнения корзины. В ответе вернется текущая информация о выбранных товарах — цены до и после применения скидок, бонусные товары.
- Используйте метод покупки корзины Создание заказа со всеми товарами из текущей корзины. В ответе вернутся ID заказа и платежный токен. Заказу будет присвоен статус
new.
Используйте полученный токен для открытия платежного интерфейса в новом окне. Другие способы открытия платежного интерфейса описаны в документации.
| Действие | Эндпоинт |
|---|---|
| Открыть в боевом окружении. | https://secure.xsolla.com/paystation4/?token={token} |
| Открыть в тестовом окружении. | https://sandbox-secure.xsolla.com/paystation4/?token={token} |
Примечание
Используйте тестовый режим (sandbox-режим) при разработке и тестировании — при совершении тестовой покупки с реальных счетов не списываются деньги. Для тестирования вы можете использовать тестовые банковские карты.
Используйте тестовый режим (sandbox-режим) при разработке и тестировании — при совершении тестовой покупки с реальных счетов не списываются деньги. Для тестирования вы можете использовать тестовые банковские карты.
После проведения первого реального платежа в силу вступает строгая политика платежей в тестовом окружении. Проведение платежа в нем будет доступно только для пользователей, которые указаны в Личном кабинете в разделе Настройки компании > Пользователи.
Покупка виртуальной валюты и виртуальных предметов за реальную валюту возможна после подписания лицензионного договора с Xsolla. Для этого в Личном кабинете перейдите в Договоры и налоги > Договоры, заполните договор и дождитесь подтверждения согласования. Согласование может занять до 3 рабочих дней.
Для включения или отключения тестового режима вам необходимо изменить значение параметра sandbox в теле запроса методов быстрой покупки и покупки корзины. По умолчанию тестовый режим выключен.
Возможные статусы заказа: - new — заказ создан; - paid — оплата получена; - done — товар начислен; - canceled — заказ отменен; - expired — истек срок оплаты.
Отслеживайте статус одним из следующих способов:
- через настройку вебхуков на сервере вашего приложения;
- через простые запросы (short-polling);
- WebSocket API.
Методы API для запроса большого количества записей (например, для построения каталога) возвращают данные постранично. Пагинация — это механизм ограничения количества элементов, возвращаемых в одном ответе API, с возможностью последовательного получения следующих страниц.
Для управления количеством возвращаемых элементов используйте следующие параметры:
limit— количество элементов на странице;offset— номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0);has_more— есть ли следующая страница;total_items_count— общее количество элементов.
Пример запроса:
GET /items?limit=20&offset=40Пример ответа:
{
"items": [...],
"has_more": true,
"total_items_count": 135
}Рекомендуется выполнять последовательные запросы до тех пор, пока в ответе не вернется has_more = false.
Дата и время передаются в формате ISO 8601.
Поддерживаются:
- смещение относительно UTC;
- значение
null, когда нет ограничения времени отображения предмета; - в отдельных полях используется Unix timestamp (в секундах).
Формат: YYYY-MM-DDTHH:MM:SS±HH:MM
Пример: 2026-03-16T10:00:00+03:00
Xsolla поддерживает локализацию пользовательских полей, таких как название и описание товаров. Локализованные значения передаются в виде объекта, в котором ключом является код языка. Полный список поддерживаемых языков приведен в документации.
Поддерживаемые поля
Локализация может быть задана для следующих параметров:
namedescriptionlong_description
Формат локали
Ключ локали может быть указан в одном из следующих форматов:
- двухбуквенный код языка:
en,ru - формат язык–страна:
en-US,ru-RU,de-DE
Примеры
Пример с двухбуквенным кодом языка:
{
"name": {
"en": "Starter Pack",
"ru": "Стартовый набор"
}
}Пример с форматом язык–страна:
{
"description": {
"en-US": "Premium bundle",
"de-DE": "Premium-Paket"
}
}При возникновении ошибки API возвращает HTTP-статус и тело ответа в формате JSON. Полный список ошибок в работе магазина приведен в документации.
Пример ответа:
{
"errorCode": 1102,
"errorMessage": "Validation error",
"statusCode": 422,
"transactionId": "c9e1a..."
}errorCode— код ошибки.errorMessage— краткое описание ошибки.statusCode— HTTP статус ответа.transactionId— ID запроса. Возвращается не во всех случаях.errorMessageExtended— дополнительные данные об ошибке, например параметры запроса. Возвращаются не во всех случаях.
Пример расширенного ответа:
{
"errorCode": 7001,
"errorMessage": "Chain not found",
"errorMessageExtended": {
"chain_id": "test_chain_id",
"project_id": "test_project_id",
"step_number": 2
},
"statusCode": 404
}Частые HTTP-статусы
400— некорректный запрос401— ошибка аутентификации403— недостаточно прав доступа404— ресурс не найден422— ошибка валидации данных429— превышено ограничение частоты запросов
Рекомендации
- Обрабатывайте HTTP-статус и тело ответа совместно.
- Используйте
errorCodeдля обработки ошибок, связанных с логикой работы приложения. - Используйте
transactionId, чтобы быстрее идентифицировать запросы при анализе ошибок.
Скачать описание OpenAPI
Языки
Серверы
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/ru/api/catalog/
Основная информация
С помощью виртуальных предметов и валюты вы можете построить внутриигровой магазин и настроить его отображение пользователям. Доступны следующие типы товаров:
- Виртуальные предметы — внутриигровые товары, например оружие, скины или бустеры. Продаются за реальные деньги или виртуальную валюту.
- Виртуальная валюта — внутриигровая валюта для покупки виртуальных предметов. Продается за реальные деньги или виртуальную валюту.
- Пакеты виртуальной валюты — фиксированное количество виртуальной валюты. Продается за реальные деньги или виртуальную валюту.
Для организации товаров в каталоге используются группы. Они позволяют логически объединять товары и управлять их отображением.
Используйте методы подраздела Admin для создания, обновления и удаления товаров.
Используйте методы подраздела Catalog для получения списков товаров и их отображения пользователям.
Уведомление
Не используйте методы подраздела Admin для построения каталога пользователям.
Не используйте методы подраздела Admin для построения каталога пользователям.
Примечание
Метод Получение списка виртуальных предметов возвращает подробные данные о предметах, включая цены и атрибуты, и поддерживает пагинацию — используйте его для отображения страниц каталога в витрине магазина.
Метод Получение списка всех виртуальных предметов возвращает артикул, название и описание предмета, а также ID и название группы без пагинации — используйте его для поиска или индексирования на стороне клиента.
Метод Получение списка виртуальных предметов возвращает подробные данные о предметах, включая цены и атрибуты, и поддерживает пагинацию — используйте его для отображения страниц каталога в витрине магазина.
Метод Получение списка всех виртуальных предметов возвращает артикул, название и описание предмета, а также ID и название группы без пагинации — используйте его для поиска или индексирования на стороне клиента.
Для реализации покупок за виртуальную валюту используйте метод Создание заказа с указанным товаром, приобретенным за виртуальную валюту. Открывать платежный интерфейс не нужно — списание происходит в момент вызова метода.
Пример сценария покупки товара за виртуальную валюту:
Запрос
Retrieves a list of virtual currencies from the specified group for building a catalog.
. Внимание
Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ.Чтобы получить больше данных постранично, используйте поля limit и offset.
Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ.Чтобы получить больше данных постранично, используйте поля limit и offset.
Примечание
Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.Безопасность
XsollaLoginUserJWT
Путь
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта, а также в адресной строке браузера при работе с проектом. URL-адрес имеет следующий формат: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.
Пример: 44056
Запрос
Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).
Пример: offset=0
Язык ответа. Двухбуквенный код языка в нижнем регистре по стандарту ISO 639-1 (например, en).Коды локали из пяти символов (например, en-US) поддерживаются в полях локализации (например, name, description),но в ответах приводятся к двухбуквенному формату. Полный список поддерживаемых языков приведен в документации.
По умолчанию "en"
Элементы Перечисление"media_list""order""long_description""custom_attributes""item_order_in_group"
Двухбуквенное обозначение страны в верхнем регистре согласно стандарту ISO 3166-1 alpha-2. Ознакомьтесь со списком стран, поддерживаемых Xsolla, а также с процессом определения страны.
Пример: country=US
Уникальный код, чувствительный к регистру. Содержит буквы и цифры.
Пример: promo_code=WINTER2021
- https://store.xsolla.com/api/v2/project/{project_id}/items/virtual_currency/group/{external_id}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/items/virtual_currency/group/{external_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://store.xsolla.com/api/v2/project/44056/items/virtual_currency/group/weapons?limit=50&offset=0&locale=en&additional_fields%5B%5D=media_list&country=US&promo_code=WINTER2021&show_inactive_time_limited_items=1' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Список виртуальных валют из указанной группы получен успешно.
Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.
Пример: "crystal"
Группы, к которым принадлежит товар.
External item group ID specified during creation.
Пример: "exclusive"
Список атрибутов и их значений, соответствующих товару. Может использоваться для фильтрации каталога.
Уникальный ID атрибута. external_id может содержать только строчные и заглавные латинские буквы, цифры, тире и подчеркивания.
Название атрибута.
Пример: "Genre"
URL-адрес изображения.
Пример: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
Цены на товар.
Валюта, в которой указана цена товара. Трехбуквенный код в соответствии с ISO 4217. Подробную информацию о валютах, поддерживаемых Xsolla, смотрите в документации.
Пример: "USD"
Виртуальные цены.
Пример: [{"amount":100,"sku":"com.xsolla.crystals_1","is_default":true,"amount_without_discount":100,"image_url":"http://image.png"}]
Item price in virtual currency without discount. Always equal to amount since discounts are not applied to prices in virtual currency.
Пример: 200
Является ли ценой в виртуальной валюте по умолчанию.
Пример: true
URL-адрес изображения виртуальной валюты.
Пример: "http://image.png"
Item type. For virtual currency, it is virtual_currency.
Пример: "virtual_currency"
Примененные акции для отдельных товаров в корзине. Массив возвращается, если:
Скидочная акция настроена для отдельного товара.
Используется промокод с настройкой Скидка на выбранные товары.
Если акции на уровне отдельных товаров не применялись, возвращается пустой массив.
Тип бонусного товара.
Перечисление"virtual_good""virtual_currency""bundle""physical_good""game_key""nft"
Название бонусного товара. Недоступно для типа бонусного товара physical_good.
URL-адрес изображения бонусного бандла. Недоступно для типа бонусного товара physical_good.
Ограничения на продажу товара.
Ограничения на продажу товара для пользователя.
Максимальное количество товара, которое может приобрести один пользователь.
Пример: 5
Оставшееся количество товара, которое может приобрести текущий пользователь.
Пример: 3
One of:
Период обновления ограничений на продажу товара для пользователя.
object or null
Определяет видимость товара в каталоге после достижения лимита покупок до момента следующего обновления лимитов.
Применяется к товарам, для которых задано регулярное обновление лимитов в массиве recurrent_schedule.
Если обновление лимитов не задано, товар не отображается в каталоге после достижения лимита независимо от значения limit_exceeded_visibility.
Возможные значения:
show— Товар возвращается в методах получения каталога товаров после достижения лимита покупок. В клиентских методах получения каталога после достижения лимита товар возвращается с флагомcan_be_bought: false. Дата следующего сброса возвращается вreset_next_date.hide— Товар не возвращается в методах получения каталога товаров после достижения лимита покупок до момента сброса лимитов.
Перечисление"show""hide"
Ограничения на продажу для конкретного товара.
Период продажи товара.
Дата, когда указанный товар будет доступен для продажи.
Пример: "2020-08-11T10:00:00+03:00"
Список призовых баллов для товара.
Ответ
application/json
{ "has_more": false, "items": [ { … }, { … } ] }
Запрос
Retrieves a list of virtual currency packages from the specified group for building a catalog.
. Внимание
Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ.Чтобы получить больше данных постранично, используйте поля limit и offset.
Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ.Чтобы получить больше данных постранично, используйте поля limit и offset.
Примечание
Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке
Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.Безопасность
XsollaLoginUserJWT
Путь
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта, а также в адресной строке браузера при работе с проектом. URL-адрес имеет следующий формат: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.
Пример: 44056
Запрос
Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).
Пример: offset=0
Язык ответа. Двухбуквенный код языка в нижнем регистре по стандарту ISO 639-1 (например, en).Коды локали из пяти символов (например, en-US) поддерживаются в полях локализации (например, name, description),но в ответах приводятся к двухбуквенному формату. Полный список поддерживаемых языков приведен в документации.
По умолчанию "en"
Additional fields to include in the response. By default, these fields are not returned. Pass the required values to include them.
Элементы Перечисление"media_list""order""long_description""custom_attributes""item_order_in_group"
Двухбуквенное обозначение страны в верхнем регистре согласно стандарту ISO 3166-1 alpha-2. Ознакомьтесь со списком стран, поддерживаемых Xsolla, а также с процессом определения страны.
Пример: country=US
Уникальный код, чувствительный к регистру. Содержит буквы и цифры.
Пример: promo_code=WINTER2021
- https://store.xsolla.com/api/v2/project/{project_id}/items/virtual_currency/package/group/{external_id}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/items/virtual_currency/package/group/{external_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://store.xsolla.com/api/v2/project/44056/items/virtual_currency/package/group/weapons?limit=50&offset=0&locale=en&additional_fields%5B%5D=media_list&country=US&promo_code=WINTER2021&show_inactive_time_limited_items=1' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Список пакетов виртуальной валюты из указанной группы получен успешно.
Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.
Пример: "crystal-pack"
Группы, к которым принадлежит товар.
External item group ID specified during creation.
Пример: "exclusive"
Список атрибутов и их значений, соответствующих товару. Может использоваться для фильтрации каталога.
Уникальный ID атрибута. external_id может содержать только строчные и заглавные латинские буквы, цифры, тире и подчеркивания.
Название атрибута.
Пример: "Genre"
Bundle type. Always virtual_currency_package for virtual currency packages.
Пример: "virtual_currency_package"
URL-адрес изображения.
Пример: "https://cdn.xsolla.net/items/crystal-pack.png"
Цены на товар.
Валюта, в которой указана цена товара. Трехбуквенный код в соответствии с ISO 4217. Подробную информацию о валютах, поддерживаемых Xsolla, смотрите в документации.
Пример: "USD"
Виртуальные цены.
Item price in virtual currency without discount. Always equal to amount since discounts are not applied to prices in virtual currency.
Пример: 200
Является ли ценой в виртуальной валюте по умолчанию.
Пример: true
URL-адрес изображения виртуальной валюты.
Пример: "http://image.png"
Item type. For virtual currency, it is virtual_currency.
Пример: "virtual_currency"
Содержимое пакета виртуальной валюты.
Пример: [{"description":"Crystal - short description","image_url":"https://cdn.xsolla.net/items/crystal-pack.png","sku":"com.xsolla.crystal_1","name":"Crystals","type":"virtual_currency","quantity":100}]
Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.
Пример: "com.xsolla.crystal_1"
Item type. For virtual currency, it is virtual_currency.
Пример: "virtual_currency"
URL-адрес изображения.
Пример: "https://cdn.xsolla.net/items/crystal-pack.png"
Ограничения на продажу товара.
Ограничения на продажу товара для пользователя.
Максимальное количество товара, которое может приобрести один пользователь.
Пример: 5
Оставшееся количество товара, которое может приобрести текущий пользователь.
Пример: 3
One of:
Период обновления ограничений на продажу товара для пользователя.
object or null
Определяет видимость товара в каталоге после достижения лимита покупок до момента следующего обновления лимитов.
Применяется к товарам, для которых задано регулярное обновление лимитов в массиве recurrent_schedule.
Если обновление лимитов не задано, товар не отображается в каталоге после достижения лимита независимо от значения limit_exceeded_visibility.
Возможные значения:
show— Товар возвращается в методах получения каталога товаров после достижения лимита покупок. В клиентских методах получения каталога после достижения лимита товар возвращается с флагомcan_be_bought: false. Дата следующего сброса возвращается вreset_next_date.hide— Товар не возвращается в методах получения каталога товаров после достижения лимита покупок до момента сброса лимитов.
Перечисление"show""hide"
Ограничения на продажу для конкретного товара.
Примененные акции для отдельных товаров в корзине. Массив возвращается, если:
Скидочная акция настроена для отдельного товара.
Используется промокод с настройкой Скидка на выбранные товары.
Если акции на уровне отдельных товаров не применялись, возвращается пустой массив.
Тип бонусного товара.
Перечисление"virtual_good""virtual_currency""bundle""physical_good""game_key""nft"
Название бонусного товара. Недоступно для типа бонусного товара physical_good.
URL-адрес изображения бонусного бандла. Недоступно для типа бонусного товара physical_good.
Ограничения на продажу товара.
Ограничения на продажу товара для пользователя.
Максимальное количество товара, которое может приобрести один пользователь.
Пример: 5
Оставшееся количество товара, которое может приобрести текущий пользователь.
Пример: 3
One of:
Период обновления ограничений на продажу товара для пользователя.
object or null
Определяет видимость товара в каталоге после достижения лимита покупок до момента следующего обновления лимитов.
Применяется к товарам, для которых задано регулярное обновление лимитов в массиве recurrent_schedule.
Если обновление лимитов не задано, товар не отображается в каталоге после достижения лимита независимо от значения limit_exceeded_visibility.
Возможные значения:
show— Товар возвращается в методах получения каталога товаров после достижения лимита покупок. В клиентских методах получения каталога после достижения лимита товар возвращается с флагомcan_be_bought: false. Дата следующего сброса возвращается вreset_next_date.hide— Товар не возвращается в методах получения каталога товаров после достижения лимита покупок до момента сброса лимитов.
Перечисление"show""hide"
Ограничения на продажу для конкретного товара.
Период продажи товара.
Дата, когда указанный товар будет доступен для продажи.
Пример: "2020-08-11T10:00:00+03:00"
Список призовых баллов для товара.
Ответ
application/json
{ "has_more": false, "items": [ { … }, { … } ] }
Основная информация
Игровые ключи — это разовые уникальные буквенно‑цифровые коды, которые дают пользователю доступ к игре или DLC на игровых платформах. Продажа игровых ключей возможна по прямой ссылке, через интерфейс магазина или через виджет. Вы также можете настроить региональные ограничения, чтобы продавать игровые ключи в определенных странах. Подробная информация об игровых ключах доступна в разделе Пакеты игровых ключей.
Для продажи игровых ключей аутентификация пользователей не требуется — ключи отправляются пользователю на указанный при покупке email-адрес. Настройка аутентификации обязательна, чтобы реализовать дополнительные сценарии: настроить персонализацию, ограничения на покупку или систему владения играми. Подробная информация доступна в разделе Как настроить аутентификацию для продажи игровых ключей.
Сценарий продажи игровых ключей:
- Создайте игру с помощью метода API Создание игры.
- Настройте региональные ограничения.
- Загрузите ключи в пакет игровых ключей с помощью метода API Загрузка кодов, чтобы продавать их пользователям.
- Отобразите пользователю каталог игр с ценами для его региона с помощью метода API Получение списка игр.
- Сформируйте заказ. Например, для быстрой покупки вы можете использовать метод API Создание заказа с указанным товаром, передав артикул игрового ключа. В ответе вы получите токен для открытия платежного интерфейса.
- Реализуйте открытие платежного интерфейса для оплаты заказа.
Настройте отслеживание статуса заказа, например с помощью вебхуков, чтобы своевременно получать данные об успешно оплаченных товарах и начислять их пользователю. Ключи отправляются пользователю на указанный при покупке email-адрес, после этого заказ переходит в статус done.
Основная информация
Бандл — набор товаров, который продается как единое целое. В состав бандла можно добавить виртуальные предметы, виртуальную валюту, пакеты виртуальной валюты, игровые ключи и другие бандлы. Используйте бандлы для создания стартовых наборов, сезонных предложений и специальных предложений.
Используйте следующие группы методов API для работы с бандлами:
- Admin — для создания, обновления, удаления бандлов и управления их видимостью.
- Catalog — для получения списка бандлов.
Лимит на количество покупок настраивается с помощью объекта limits при создании или обновлении бандла. Подробная информация приведена в разделе Лимиты. Вы также можете настроить региональные ограничения, чтобы продавать товары в определенных странах.
Сценарий работы с бандлами:
- Создайте бандл с помощью метода API Создание бандла. Чтобы проверить созданный бандл, используйте метод API Получение бандла. Чтобы получить список всех бандлов в проекте, используйте метод API Получение списка бандлов.
- При необходимости используйте метод API Обновление бандла для для изменения его состава или настроек.
- Реализуйте логику отображения бандлов в магазине с помощью методов API Получение списка бандлов, Получение указанного бандла или Получение списка бандлов по указанной группе.
- Сформируйте заказ, используя методы раздела Корзина и оплата. Например, для быстрой покупки вы можете использовать метод API Создание заказа с указанным товаром, передав артикул бандла. В ответе вы получите токен для открытия платежного интерфейса.
- Реализуйте открытие платежного интерфейса для оплаты заказа.
- Настройте отслеживание статуса заказа, например с помощью вебхуков, чтобы своевременно получать данные об успешно оплаченных товарах и начислять их пользователю.
Основная информация
Корзина — это механизм покупки, который позволяет объединять несколько товаров в одном заказе. Пользователь может купить товары любого типа в любом количестве за реальную валюту, а также использовать промокоды.
Корзина хранится на стороне Xsolla. Сохранение корзины между сессиями зависит от того, авторизован ли пользователь:
Для авторизованных пользователей корзина привязана к конкретному пользователю и сохраняется между сессиями, пока запросы выполняются от имени того же пользователя.
- Для неавторизованных пользователей сохранение корзины зависит от передачи заголовка
x-unauthorized-id. Чтобы сохранить корзину неавторизованного пользователя между сессиями, передавайте один и тот жеx-unauthorized-idв каждом запросе. Этот вариант доступен только при продаже игровых ключей.
- Для неавторизованных пользователей сохранение корзины зависит от передачи заголовка
Вы можете идентифицировать корзину двумя способами: автоматически по JWT пользователя или по ID корзины (cart_id).
Управление корзиной доступно как на стороне клиента, так и на стороне сервера.
На стороне сервера вы можете наполнить корзину товарами, например при восстановлении сессии пользователя. На стороне клиента доступны следующие действия:
- получить корзину текущего пользователя или по ID корзины;
- наполнить корзину;
- обновить товары в корзине;
- удалить товары из корзины.
Для оплаты товаров из корзины используются клиентские и серверные методы создания заказа.
По умолчанию время жизни корзины — 72 часа. Если состав корзины изменился, например при добавлении нового товара, ее время жизни продлевается.
После успешной оплаты корзина не очищается автоматически. Чтобы очистить корзину, используйте следующие клиентские методы API:
Удаление товара из корзины по ID корзины и Удаление товара из текущей корзины — корзина очищается, когда вы удаляете последний товар из нее.
Сценарий использования корзины:
Реализуйте интерфейс магазина, в котором пользователь будет выбирать товары.
Когда пользователь выбирает товары в магазине, добавьте их в корзину, например с помощью метода Наполнение корзины товарами. В массиве items необходимо передать артикулы и количество необходимых товаров.
Реализуйте интерфейс просмотра корзины. При переходе пользователя в корзину отобразите ее содержимое с помощью метода Получение корзины текущего пользователя. В ответе отобразится информация об итоговой цене товаров с учетом скидок, а также примененных акциях.
Реализуйте открытие платежного интерфейса для оплаты заказа. Например, вы можете вызвать метод Создание заказа со всеми товарами из определенной корзины. В ответе вы получите токен для открытия платежного интерфейса.
Настройте отслеживание статуса заказа, например с помощью вебхуков, чтобы своевременно получать данные об успешно оплаченных товарах и начислять их пользователю.
Примечание
Подробная информация о настройке продажи товаров в игре и онлайн приведена в руководстве по интеграции.
Жизненный цикл заказа
Понимание жизненного цикла заказа поможет вам при настройке его отслеживания, например, чтобы начислить товары пользователю после успешной оплаты.
Заказ переходит по следующим статусам:
| Статус | Описание | Примечание |
new | Заказ создан. Система ожидает подтверждение оплаты. | Описания статусов транзакций приведены в документации Pay Station API. |
paid | Заказ оплачен (транзакция перешла в статус done), и товар может быть начислен пользователю. | Пока заказ не оплачен, он находится в статусе new. |
done | Товар из заказа начислен пользователю. | — |
canceled | Пользователь оформил возврат платежа. | Заказ переходит в этот статус, когда статус транзакции меняется на refunded. |
expired | Если новый заказ включает в себя товар, промокод или акцию, на которые настроены ограничения, предыдущий неоплаченный заказ с этим же товаром переходит в статус expired. Пользователь может оплатить только последний созданный заказ. | Если пользователь пытается оплатить заказ, который находится в этом статусе, в платежном интерфейсе он увидит ошибку 2002 и не сможет совершить платеж. |
Примечание
Если в процессе оплаты заказ перешел в статус expired, но пользователь успешно завершил платеж, заказ переходит из статуса expired в paid. Это возможно только если при оплате такого заказа не будет превышен лимит на покупку товара.
Бесплатные товары
Используйте методы из этого подраздела для начисления бесплатных товаров пользователям.
Операции
Основная информация
Лимиты на покупку ограничивают количество товаров, доступных одному пользователю или всем пользователям. Вы также можете задавать периоды автоматического обновления лимитов.
Лимиты хранятся на стороне Xsolla и задаются на уровне конкретного товара в Личном кабинете или через объект limits в следующих методах API:
- Создание виртуального предмета
- Создание игры
- Создание виртуальной валюты
- Создание пакета виртуальной валюты
- Создание бандла
Информация о лимитах возвращается в объекте items.limits в методах получения каталога товаров:
- Получение списка виртуальных предметов
- Получение списка виртуальных валют
- Получение списка пакетов виртуальной валюты
- Получение списка бандлов
- Получение списка игр
Методы подраздела Управление из группы методов Лимиты позволяют получать информацию о текущем состоянии лимитов и изменять их для конкретного пользователя — например, сбрасывать счетчик после выполнения квеста или корректировать остаток вручную.
Примечание
Подробная информация по настройке лимитов в каталоге приведена в разделе Лимиты на покупку товаров.
Подробная информация по настройке лимитов в каталоге приведена в разделе Лимиты на покупку товаров.