Перейти к содержимому
/
Получение кодов

Catalog API (2.0.0)

Overview

  • 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 предоставляет методы для управления каталогом вашего внутриигрового магазина и обработки покупок. Используйте методы для настройки виртуальных предметов, виртуальных валют, игровых ключей, бандлов, процессов корзины и оплаты, атрибутов товаров, а также для импорта товаров из внешних источников.

Скачать описание OpenAPI
index.json
index.yaml
Языки
Серверы
Mock server
https://xsolla.redocly.app/_mock/ru/api/catalog/
https://store.xsolla.com/api/

Admin

Операции

Catalog

Операции

Виртуальная оплата

Операции

Catalog

Операции

Владение играми

Операции

Admin

Операции

Получение кодов по IDServer-sideAdmin

Запрос

Получает определенное количество кодов по ID игрового ключа.

Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

Пример: 44056
item_idstringобязательный

ID предмета (артикул).

Пример: 656
Запрос
user_emailstringобязательный

Email-адрес пользователя.

Пример: user_email=email@email.com
quantityintegerобязательный

Количество кодов.

Пример: quantity=100
reasonstringобязательный

Причина получения кодов.

Пример: reason=Very important
region_idinteger

ID региона.

По умолчанию 1
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/44056/admin/items/game/key/request/id/656?user_email=email%40email.com&quantity=100&reason=Very+important&region_id=1'

Ответы

Коды успешно получены.

Телоtext/plain
string
Ответ
text/plain
PIN-CODE-ALL PIN-CODE-ALL-3

Получение кодовServer-sideAdmin

Запрос

Получает определенное количество кодов по артикулу игрового ключа.

Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

Пример: 44056
item_skustringобязательный

Артикул товара.

Пример: booster_mega_1
Запрос
user_emailstringобязательный

Email-адрес пользователя.

Пример: user_email=email@email.com
quantityintegerобязательный

Количество кодов.

Пример: quantity=100
reasonstringобязательный

Причина получения кодов.

Пример: reason=Very important
region_idinteger

ID региона.

По умолчанию 1
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/44056/admin/items/game/key/request/sku/booster_mega_1?user_email=email%40email.com&quantity=100&reason=Very+important&region_id=1'

Ответы

Коды успешно получены.

Телоtext/plain
string
Ответ
text/plain
PIN-CODE-ALL PIN-CODE-ALL-3

Загрузка кодов по IDServer-sideAdmin

Запрос

Загружает коды по ID игрового ключа.

Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта.

Пример: 44056
item_idstringобязательный

ID предмета (артикул).

Пример: 656
Телоmultipart/form-data
filestring(binary)обязательный

Файл с кодами.

Пример: "keys.txt"
region_idinteger

ID региона.

Пример: 1
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/44056/admin/items/game/key/upload/id/656 \
  -H 'Content-Type: multipart/form-data' \
  -F file=keys.txt \
  -F region_id=1

Ответы

Информация о сеансе загрузки кодов успешно получена.

Телоapplication/json
count_skippedinteger
Пример: 10
count_totalinteger
Пример: 100
count_uploadedinteger
Пример: 0
session_idstring
Пример: "fc7105b6e8ee01339582970b37697242"
statusstring
Пример: "processing"
Ответ
application/json
{
  "count_skipped": 10,
  "count_total": 100,
  "count_uploaded": 0,
  "session_id": "fc7105b6e8ee01339582970b37697242",
  "status": "processing"
}

Admin

Операции

Catalog

Операции

Корзина (на стороне клиента)

Операции

Корзина (на стороне сервера)

Операции

Оплата (на стороне клиента)

Операции

Оплата (на стороне сервера)

Операции

Заказ

Операции

Бесплатные товары

Операции

Управление

Операции

Admin

Операции

Вебхуки

Операции

Предзаказы

Операции

Продавец

Операции

Catalog

Данный API позволяет получать продаваемые товары любого вида или конкретный товар.

Операции

Общие регионы

Операции

Admin

Операции