- Получение списка пакетов виртуальной валюты
Catalog API (2.0.0)
- Версия: 2.0.0
- Серверы:
https://store.xsolla.com/api - Свяжитесь с нами по электронной почте
- Адрес для связи: https://xsolla.com/
- Требуемая версия TLS: 1.2
API каталога позволяет настраивать каталог внутриигровых товаров на стороне Xsolla и отображать каталог пользователям в вашем игровом магазине.
API позволяет вам управлять такими сущностями каталога, как:
- Виртуальные предметы — внутриигровые предметы, например оружие, скины, бустеры.
- Виртуальная валюта — виртуальные деньги, которые используются для приобретения виртуальных товаров. Пакеты виртуальной валюты — предустановленные наборы виртуальной валюты.
- Бандлы — комбинированные наборы виртуальных предметов, валюты или игровых ключей, продаваемые как единый артикул.
- Игровые ключи — ключи для игр и DLC, распространяемые через такие платформы, как Steam, или других DRM-провайдеров.
- Группы — логические группировки для организации и сортировки товаров в каталоге.
Методы API делятся на следующие группы:
Admin — методы для создания, обновления, удаления и настройки товаров и групп каталога. Для вызова требуется базовая HTTP-аутентификация с использованием учетных данных Личного кабинета. Не предназначены для построения витрин для конечных пользователей.Catalog — методы для получения товаров и построения витрин для конечных пользователей. Поддерживают опциональную аутентификацию с использованием JWT пользователя для возврата персонализированных данных, таких как пользовательские лимиты и активные промоакции.
Запрос
Получает список виртуальных валют для построения каталога.
Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset.
Использование каталога товаров доступно без авторизации, но для получения персонализированного каталога необходимо передать JWT пользователя в заголовке Authorization.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).
Язык ответа. Двухбуквенный код языка в нижнем регистре в соответствии с ISO 639-1.
Список дополнительных полей. Эти поля будут указаны в ответе, если вы отправите их в своем запросе.
Двухбуквенное обозначение страны в верхнем регистре согласно стандарту ISO 3166-1 alpha-2. Ознакомьтесь со списком стран, поддерживаемых Xsolla, а также с процессом определения страны.
Уникальный код, чувствительный к регистру. Содержит буквы и цифры.
- https://store.xsolla.com/api/v2/project/{project_id}/items/virtual_currency
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/items/virtual_currency
- 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?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>'{ "has_more": false, "items": [ { … }, { … }, { … } ] }
Запрос
Получает список пакетов виртуальной валюты для построения каталога.
Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset.
Использование каталога товаров доступно без авторизации, но для получения персонализированного каталога необходимо передать JWT пользователя в заголовке Authorization.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).
Язык ответа. Двухбуквенный код языка в нижнем регистре в соответствии с ISO 639-1.
Список дополнительных полей. Эти поля будут указаны в ответе, если вы отправите их в своем запросе.
Двухбуквенное обозначение страны в верхнем регистре согласно стандарту ISO 3166-1 alpha-2. Ознакомьтесь со списком стран, поддерживаемых Xsolla, а также с процессом определения страны.
Уникальный код, чувствительный к регистру. Содержит буквы и цифры.
- https://store.xsolla.com/api/v2/project/{project_id}/items/virtual_currency/package
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/items/virtual_currency/package
- 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?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>'{ "has_more": false, "items": [ { … }, { … } ] }
Запрос
Получает пакет виртуальной валюты по артикулу для построения каталога.
Без авторизации метод возвращает общие данные. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Язык ответа. Двухбуквенный код языка в нижнем регистре в соответствии с ISO 639-1.
Двухбуквенное обозначение страны в верхнем регистре согласно стандарту ISO 3166-1 alpha-2. Ознакомьтесь со списком стран, поддерживаемых Xsolla, а также с процессом определения страны.
Отображает предметы с ограниченным сроком действия, которые недоступны пользователю. Срок действия таких предметов еще не начался или уже истек.
- https://store.xsolla.com/api/v2/project/{project_id}/items/virtual_currency/package/sku/{virtual_currency_package_sku}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/items/virtual_currency/package/sku/{virtual_currency_package_sku}
- 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/sku/crystal-pack?locale=en&country=US&show_inactive_time_limited_items=1&additional_fields%5B%5D=media_list' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Пакет виртуальной валюты был успешно получен.
Список атрибутов и их значений, соответствующих товару. Может использоваться для фильтрации каталога.
Содержимое пакета виртуальной валюты.
JSON-объект, содержащий атрибуты товара и их значения.
Группы, к которым принадлежит товар.
URL-адрес изображения.
Примененные акции для отдельных товаров в корзине. Массив возвращается, если:
Скидочная акция настроена для отдельного товара.
Используется промокод с настройкой Скидка на выбранные товары.
Если акции на уровне отдельных товаров не применялись, возвращается пустой массив.
Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.
{ "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { … } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Crystal Pack Short Description", "groups": [], "image_url": "http://vc_package_image.png", "is_free": false, "item_id": 488832, "limits": { "per_item": null, "per_user": { … } }, "name": "Crystal Pack", "periods": [ { … } ], "price": { "amount": "100", "amount_without_discount": "100", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.crystal_pack_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }