Catalog API (2.0.0)
- Version: 2.0.0
- Servers:
https://store.xsolla.com/api - Contact Us by Email
- Contact URL: https://xsolla.com/
- Required TLS version: 1.2
Catalog API предоставляет методы для управления каталогом вашего внутриигрового магазина и обработки покупок. Используйте методы для настройки виртуальных предметов, виртуальных валют, игровых ключей, бандлов, процессов корзины и оплаты, атрибутов товаров, а также для импорта товаров из внешних источников.
Запрос
Получает иговой ключ для каталога.
Без авторизации метод возвращает общие данные. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Язык ответа. Двухбуквенный код языка в нижнем регистре в соответствии с ISO 639-1.
Список дополнительных полей. Эти поля будут указаны в ответе, если вы отправите их в своем запросе.
Двухбуквенное обозначение страны в верхнем регистре согласно стандарту ISO 3166-1 alpha-2. Ознакомьтесь со списком стран, поддерживаемых Xsolla, а также с процессом определения страны.
Уникальный код, чувствительный к регистру. Содержит буквы и цифры.
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/items/game/key/sku/{item_sku}
- https://store.xsolla.com/api/v2/project/{project_id}/items/game/key/sku/{item_sku}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/44056/items/game/key/sku/{item_sku}?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 платформы. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.
Группы, к которым принадлежит товар.
URL-адрес изображения.
Если true, игра на платформе находится в предзаказе и дата релиза еще не прошла.
Цены на товар.
Примененные акции для отдельных товаров в корзине. Массив возвращается, если:
Скидочная акция настроена для отдельного товара.
Используется промокод с настройкой Скидка на выбранные товары.
Если акции на уровне отдельных товаров не применялись, возвращается пустой массив.
Дата выпуска игры на платформе в формате ISO 8601.
Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.
{ "attributes": [ { … }, { … } ], "can_be_bought": true, "description": "Game description", "drm_name": "Steam", "drm_sku": "steam_key_1", "groups": [ { … }, { … } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "limits": null, "name": "Game name", "periods": [ { … } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_1", "type": "game_key", "virtual_prices": [] }
Запрос
Получает игру для каталога.
Без авторизации метод возвращает общие данные. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Язык ответа. Двухбуквенный код языка в нижнем регистре в соответствии с ISO 639-1.
Список дополнительных полей. Эти поля будут указаны в ответе, если вы отправите их в своем запросе.
Двухбуквенное обозначение страны в верхнем регистре согласно стандарту ISO 3166-1 alpha-2. Ознакомьтесь со списком стран, поддерживаемых Xsolla, а также с процессом определения страны.
Уникальный код, чувствительный к регистру. Содержит буквы и цифры.
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/items/game/sku/{item_sku}
- https://store.xsolla.com/api/v2/project/{project_id}/items/game/sku/{item_sku}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/44056/items/game/sku/{item_sku}?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>'Игра успешно получена.
Список атрибутов и их значений, соответствующих товару. Может использоваться для фильтрации каталога.
Группы, к которым принадлежит товар.
URL-адрес изображения.
Примененные акции для отдельных товаров в корзине. Массив возвращается, если:
Скидочная акция настроена для отдельного товара.
Используется промокод с настройкой Скидка на выбранные товары.
Если акции на уровне отдельных товаров не применялись, возвращается пустой массив.
Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.
{ "attributes": [ { … }, { … } ], "description": "Game description", "groups": [ { … }, { … } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "promotions": [], "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ { … }, { … } ], "unit_type": "game" }