- Получение списка товаров по указанной группе
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 пользователя для возврата персонализированных данных, таких как пользовательские лимиты и активные промоакции.
Запрос
Gets a list of all virtual items for searching on client-side.
Returns only item SKU, name, groups and description
The use of the item catalog API calls is available without authorization, but to get a personalized catalog, you must pass the user JWT in the Authorization header.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
- https://store.xsolla.com/api/v2/project/{project_id}/items/virtual_items/all
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/items/virtual_items/all
- 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_items/all?locale=en&promo_code=WINTER2021' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Список всех виртуальных предметов успешно получен.
{ "items": [ { … }, { … }, { … } ] }
Запрос
Получает список товаров из указанной группы для построения каталога.
Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset.
Без авторизации метод возвращает общие данные. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).
Язык ответа. Двухбуквенный код языка в нижнем регистре в соответствии с ISO 639-1.
Список дополнительных полей. Эти поля будут указаны в ответе, если вы отправите их в своем запросе.
Двухбуквенное обозначение страны в верхнем регистре согласно стандарту ISO 3166-1 alpha-2. Ознакомьтесь со списком стран, поддерживаемых Xsolla, а также с процессом определения страны.
Уникальный код, чувствительный к регистру. Содержит буквы и цифры.
- https://store.xsolla.com/api/v2/project/{project_id}/items/virtual_items/group/{external_id}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/items/virtual_items/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_items/group/{external_id}?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_items/sku/{item_sku}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/items/virtual_items/sku/{item_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_items/sku/booster_mega_1?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 товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.
Тип виртуального предмета.
| Перечисление Значение | Описание |
|---|---|
| consumable | Предмет исчезает из инвентаря после использования (например, патроны). |
| non_consumable | Предмет остается в инвентаре в течение неограниченного времени. |
| non_renewing_subscription | Предмет с ограниченным сроком действия, который может служить представлением доступа к сервисам или контенту в течение ограниченного периода времени. |
{ "attributes": [ { … } ], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel" }, "groups": [ { … } ], "image_url": "https://cdn.xsolla.net/img/misc/images/8ab44fe99038a56de01950ba4a971b77.png", "is_free": false, "item_id": 488833, "limits": { "per_item": null, "per_user": { … } }, "name": { "en": "Sword Xsolla Skin" }, "periods": [ { … } ], "price": { "amount": "4.99", "amount_without_discount": "4.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.swords_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [], "vp_rewards": [] }