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

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

Запрос

Создает значение атрибута.

Внимание

Все проекты имеют ограничение на количество значений атрибута. Значение по умолчанию и максимальное значение — 20 значений для каждого атрибута.
Безопасность
basicAuth
Путь
project_idintegerобязательный

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

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

External ID атрибута.

Пример: attribute_id
Телоapplication/json
external_idstring(value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$обязательный

Уникальный ID значения атрибута. external_id может содержать только строчные латинские буквы, цифры, тире и подчеркивания.

Пример: "attribute_value"
valueobject(value-name)обязательный

Объект с локализациями для названия значения. Ключи для обозначения стран указаны в стандарте ISO 3166-1.

По умолчанию {"de":"Strategie","en":"Strategy"}
Пример: {"de":"Strategie","en":"Strategy"}
value.​property name*stringдополнительное свойство
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/44056/admin/attribute/attribute_id/value \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "weapon_class_sword_value",
    "value": {
      "de": "Schwert",
      "en": "Sword"
    }
  }'

Ответы

Значение атрибута успешно создано.

Телоapplication/json
external_idstring(value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$

Уникальный ID значения атрибута. external_id может содержать только строчные латинские буквы, цифры, тире и подчеркивания.

Пример: "attribute_value"
Ответ
application/json
{ "external_id": "rpg" }

Удаление значения атрибутаServer-sideAdmin

Запрос

Удаляет значение атрибута.

Внимание

Если вы удалите значение атрибута, связь атрибута с товарами будет потеряна. Чтобы изменить значение атрибута для товара, используйте метод Обновление значения атрибута вместо удаления значения и создания нового.
Безопасность
basicAuth
Путь
project_idintegerобязательный

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

Пример: 44056
value_external_idstring^[-_\.\d\w]+$обязательный

External ID значения атрибута.

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

External ID атрибута.

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

Ответы

Значение атрибута успешно удалено.

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

Обновление значения атрибутаServer-sideAdmin

Запрос

Обновляет значения атрибута.

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

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

Пример: 44056
value_external_idstring^[-_\.\d\w]+$обязательный

External ID значения атрибута.

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

External ID атрибута.

Пример: attribute_id
Телоapplication/json
external_idstring(value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$обязательный

Уникальный ID значения атрибута. external_id может содержать только строчные латинские буквы, цифры, тире и подчеркивания.

Пример: "attribute_value"
valueobject(value-name)обязательный

Объект с локализациями для названия значения. Ключи для обозначения стран указаны в стандарте ISO 3166-1.

По умолчанию {"de":"Strategie","en":"Strategy"}
Пример: {"de":"Strategie","en":"Strategy"}
value.​property name*stringдополнительное свойство
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ru/api/catalog/v2/project/44056/admin/attribute/attribute_id/value/value_id \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "weapon_class_sword_value",
    "value": {
      "de": "Schwert",
      "en": "Sword"
    }
  }'

Ответы

Значение атрибута успешно обновлено.

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