Spanish (Spain)
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 пользователя для возврата персонализированных данных, таких как пользовательские лимиты и активные промоакции.
Скачать описание OpenAPI
Языки
Серверы
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/ru/api/catalog/
Путь
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Пример: 44056
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/bundle
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/admin/items/bundle
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://store.xsolla.com/api/v2/project/44056/admin/items/bundle?limit=50&offset=0'Ответ
application/json
{ "items": [ { … }, { … } ] }
Путь
Телоapplication/jsonобязательныйID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Пример: 44056
Объект с данными бандла.
Список атрибутов.
Внимание. Для товара невозможно указать более 20 атрибутов. Любые попытки превысить данное ограничение вызовут ошибку.
Тип бандла. Используйте standard, чтобы создать бандл с товарами и указать артикулы товаров, которые содержатся в бандле. Используйте partner_side_content, чтобы создать пустой бандл и добавить в него товары на своей стороне с помощью вебхука. Используется только для персонализации каталога товаров на стороне партнера.
По умолчанию "standard"
Перечисление"standard""partner_side_content"
Пример: "standard"
Пример: [{"quantity":1,"sku":"com.xsolla.kg_1"}]
JSON-объект, содержащий атрибуты товара и их значения. Атрибуты позволяют добавить дополнительную информацию к товарам. Например, указать уровень игрока, на котором ему станет доступен этот товар. Атрибуты дополняют внутреннюю логику игры и могут быть получены через GET-методы и вебхуки.
description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)обязательный
Объект с локализованными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.
One of:
Объект с локализованными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.
Группы, к которым принадлежит элемент.
Примечание. Строковое значение относится к группе `external_id`.
По умолчанию []
Пример: ["honor"]
URL-адрес изображения.
Пример: "https://image.example.com"
Если этот параметр отключен, товар не может быть найден и приобретен.
По умолчанию true
Пример: true
Является ли товар случайной платной наградой, например лутбоксом.
По умолчанию false
Пример: false
Товар доступен для покупки.
По умолчанию false
Пример: true
long_description(two-letter (object or null)) or (five-letter (object or null))(long-description-localization-object)
Объект с локализованными длинными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.
Any of:
Объект с локализованными длинными описаниями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код локали из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется код из двух символов. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.
Дополнительные ассеты бандла.
Пример: [{"type":"image","url":"https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"}]
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)обязательный
Объект с локализованными названиями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код языка из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется двухбуквенный код языка. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.
One of:
Объект с локализованными названиями товара. Принимает значения в одном из двух форматов: двухбуквенный код языка в нижнем регистре (например, en) или код языка из пяти символов (например, en-US). Оба формата допустимы при отправке запроса, но в ответе всегда используется двухбуквенный код языка. Если для одного языка указаны оба варианта (например, en и en-US), будет сохранено последнее переданное значение. Полный список поддерживаемых языков приведен в документации.
Уникальный ID товара. Артикул может содержать только строчные и заглавные латинские буквы, цифры, точки, тире и подчеркивания.
Пример: "bundle_1"
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/bundle
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/admin/items/bundle
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/items/bundle \
-H 'Content-Type: application/json' \
-d '{
"attributes": [
{
"external_id": "class",
"name": {
"en": "Class"
},
"values": [
{
"external_id": "soldier",
"value": {
"en": "Soldier"
}
},
{
"external_id": "officer",
"value": {
"en": "Officer"
}
}
]
}
],
"content": [
{
"quantity": 1,
"sku": "com.xsolla.iron_gloves_1"
},
{
"quantity": 1,
"sku": "com.xsolla.iron_boots_1"
},
{
"quantity": 1,
"sku": "com.xsolla.iron_shield_1"
},
{
"quantity": 1,
"sku": "com.xsolla.iron_armour_1"
},
{
"quantity": 1,
"sku": "com.xsolla.iron_helmet_1"
}
],
"custom_attributes": {
"purchased": 0,
"type": "lootbox"
},
"description": {
"de": "Brustpanzer für Soldaten",
"en": "Chest of armour for soldiers"
},
"groups": [
"chests"
],
"image_url": "https://picture.bundle-with-many-stuff.png",
"is_enabled": true,
"is_free": true,
"is_paid_randomized_reward": true,
"limits": {
"per_item": null,
"per_user": null
},
"long_description": {
"de": "Brustpanzer für Soldaten",
"en": "Chest of armour for soldiers"
},
"media_list": [
{
"type": "image",
"url": "https://test.com/image0"
},
{
"type": "image",
"url": "https://test.com/image1"
}
],
"name": {
"de": "Brustpanzer",
"en": "Chest of armour"
},
"order": 1,
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"prices": [
{
"amount": "9.99",
"currency": "USD",
"is_default": true,
"is_enabled": true
},
{
"amount": "9.99",
"currency": "EUR",
"is_default": false,
"is_enabled": true
}
],
"sku": "com.xsolla.armour_chest_1",
"vc_prices": []
}'Ответ
application/json
{ "sku": "com.xsolla.kg_1" }
Путь
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Пример: 44056
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://store.xsolla.com/api/v2/project/44056/admin/items/bundle/group/external_id/{external_id}?limit=50&offset=0'Ответ
application/json
{ "items": [ { … }, { … } ] }