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 пользователя для возврата персонализированных данных, таких как пользовательские лимиты и активные промоакции.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Оставшееся количество товаров для продажи или доступных акций для пользователя в пределах установленных ограничений.
- https://store.xsolla.com/api/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}
- 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/user/limit/item/sku/booster_mega_1 \
-H 'Content-Type: application/json' \
-d '{
"available": 1,
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
}'{ "per_user": { "available": 9, "total": 10 } }
Запрос
Устанавливает количество товаров, которые указанный пользователь может купить в пределах ограничения, примененного после его увеличения или уменьшения.
User limit API позволяет продавать товар в ограниченном количестве. Чтобы настроить ограничения покупку, перейдите в раздел Admin нужного типа товара:
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Оставшееся количество товаров для продажи или доступных акций для пользователя в пределах установленных ограничений.
- https://store.xsolla.com/api/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/user/limit/item/sku/booster_mega_1 \
-H 'Content-Type: application/json' \
-d '{
"available": 0,
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
}'{ "per_user": { "available": 9, "total": 10 } }
Запрос
Обновляет лимит на покупку товара, чтобы пользователь мог купить его снова. Если параметр user равен null, этот метод обновляет лимит для всех пользователей.
API лимитов на покупку позволяет вам продавать товар в ограниченном количестве. Чтобы настроить лимиты покупок, перейдите в раздел Admin нужного типа товара:
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
- https://store.xsolla.com/api/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}/all
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}/all
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/user/limit/item/sku/booster_mega_1/all \
-H 'Content-Type: application/json' \
-d '{
"user": {
"user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
}
}'