- Получение списка игр, принадлежащих пользователю
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 проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Объект со свойствами DRM.
Объект со свойствами игры.
Какой тип прав владения должен быть отозван. Если параметру присвоено значение sandbox, у пользователя будет отозвано право в режиме тестового окружения. Если для параметра установлено значение default, у пользователя будет отозвано право в режиме боевого окружения.
- https://store.xsolla.com/api/v2/project/{project_id}/admin/entitlement/revoke
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/admin/entitlement/revoke
- 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/entitlement/revoke \
-H 'Content-Type: application/json' \
-d '{
"drm": {
"sku": "com.xsolla.key_1"
},
"game": {
"sku": "com.xsolla.game_1"
},
"mode": "default",
"user_external_id": "user-external-id"
}'Запрос
Получает список игр, принадлежащих пользователю. Ответ будет содержать массив игр, принадлежащих определенному пользователю.
Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ.Чтобы получить больше данных постранично, используйте поля limit и offset.
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).
Какой тип прав владения должен быть возвращен. Если параметру присвоено значение 1, возвращаются права владения, полученные пользователем только в режиме тестового окружения. Если параметр не передан или установлен в 0, возвращаются права владения, полученные пользователем только в режиме боевого окружения.
- https://store.xsolla.com/api/v2/project/{project_id}/entitlement
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/entitlement
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://store.xsolla.com/api/v2/project/44056/entitlement?limit=50&offset=0&sandbox=0&additional_fields%5B%5D=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{ "has_more": false, "items": [ { … } ], "total_items_count": 1 }
ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.
- https://store.xsolla.com/api/v2/project/{project_id}/entitlement/redeem
- Mock serverhttps://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/{project_id}/entitlement/redeem
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://store.xsolla.com/api/v2/project/44056/entitlement/redeem \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"code": "AAAA-BBBB-CCCC-DDDD",
"sandbox": false
}'