Перейти к содержимому

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
Языки
Серверы
Mock server
https://xsolla.redocly.app/_mock/ru/api/catalog/
https://store.xsolla.com/api/
Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции

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

Операции

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

Операции

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

Операции

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

Операции
Операции
Операции
Операции
Операции
Операции
Операции
Операции

Catalog

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

Операции
Операции

Создание регионаServer-sideAdmin

Запрос

Создает регион.

Вы можете использовать регион для управления вашими региональными ограничениями.

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

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

Пример: 44056
Телоapplication/json
countriesArray of strings(Regions_countries)обязательный

Список стран, которые необходимо добавить в регион.
Двухбуквенное обозначение страны в верхнем регистре согласно стандарту ISO 3166-1 alpha-2. Список стран, поддерживаемых Xsolla, приведен в документации.
Пример: ["JP", "CN", "VN"]

nameobject(Regions_name)обязательный

Название региона. Данный параметр должен содержать пары ключ/значение, где ключ — это локаль в формате "^[a-z]{2}-[A-Z]{2}$", значение — строка.

По умолчанию {"de-DE":"Asien","en-US":"Asia"}
Пример: {"de-DE":"Asien","en-US":"Asia"}
name.​property name*stringдополнительное свойство
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/44056/admin/region \
  -H 'Content-Type: application/json' \
  -d '{
    "countries": [
      "JP",
      "CN",
      "VN"
    ],
    "name": {
      "de-DE": "Asien",
      "en-US": "Asia"
    }
  }'

Ответы

Регион успешно создан.

Телоapplication/json
region_idinteger(Regions_region_id)

ID региона. Уникальный идентификатор региона в рамках проекта.

Пример: 42
Ответ
application/json
{ "region_id": 42 }

Удаление регионаServer-sideAdmin

Запрос

Удаляет определенный регион.

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

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

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

ID региона. Уникальный идентификатор региона в рамках проекта.

Пример: 42
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/44056/admin/region/42

Ответы

Регион успешно удален.

Тело
Ответ
Нет содержимого

Получение регионаServer-sideAdmin

Запрос

Получает определенный регион.

Вы можете использовать регион для управления вашими региональными ограничениями.

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

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

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

ID региона. Уникальный идентификатор региона в рамках проекта.

Пример: 42
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/44056/admin/region/42

Ответы

Указанный регион успешно получен.

Телоapplication/json
countriesArray of strings(Regions_countries)

Список стран, которые необходимо добавить в регион.
Двухбуквенное обозначение страны в верхнем регистре согласно стандарту ISO 3166-1 alpha-2. Список стран, поддерживаемых Xsolla, приведен в документации.
Пример: ["JP", "CN", "VN"]

idinteger(Regions_region_id)

ID региона. Уникальный идентификатор региона в рамках проекта.

Пример: 42
nameobject(Regions_name)

Название региона. Данный параметр должен содержать пары ключ/значение, где ключ — это локаль в формате "^[a-z]{2}-[A-Z]{2}$", значение — строка.

По умолчанию {"de-DE":"Asien","en-US":"Asia"}
Пример: {"de-DE":"Asien","en-US":"Asia"}
Ответ
application/json
{ "value": { "countries": [], "id": 44, "name": {} } }
Операции