Перейти к содержимому
/
Получение списка атрибуто...

Catalog API (2.0.0)

Введение

API каталога позволяет настраивать каталог внутриигровых товаров на стороне Xsolla и отображать каталог пользователям в вашем игровом магазине.

API позволяет вам управлять такими сущностями каталога, как:

  • Виртуальные предметы — внутриигровые предметы, например оружие, скины, бустеры.
  • Виртуальная валюта — виртуальные деньги, которые используются для приобретения виртуальных товаров. Пакеты виртуальной валюты — предустановленные наборы виртуальной валюты.
  • Бандлы — комбинированные наборы виртуальных предметов, валюты или игровых ключей, продаваемые как единый артикул.
  • Игровые ключи — ключи для игр и DLC, распространяемые через такие платформы, как Steam, или других DRM-провайдеров.
  • Группы — логические группировки для организации и сортировки товаров в каталоге.

Методы API

Методы API делятся на следующие группы:

  • Admin — методы для создания, обновления, удаления и настройки товаров и групп каталога. Для вызова требуется базовая HTTP-аутентификация с использованием учетных данных Личного кабинета. Не предназначены для построения витрин для конечных пользователей.
  • Catalog — методы для получения товаров и построения витрин для конечных пользователей. Поддерживают опциональную аутентификацию с использованием JWT пользователя для возврата персонализированных данных, таких как пользовательские лимиты и активные промоакции.
Скачать описание OpenAPI
index.json
index.yaml
Языки
Серверы
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/ru/api/catalog/

Admin

Операции

Catalog

Операции

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

Операции

Catalog

Операции

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

Операции

Admin

Операции

Admin

Операции

Catalog

Операции

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

Операции

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

Операции

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

Операции

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

Операции

Заказ

Операции

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

Операции

Управление

Операции

Admin

Операции

Вебхуки

Операции

Предзаказы

Операции

Продавец

Операции

Catalog

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

Операции

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

Операции

Admin

Операции

Получение списка атрибутов (admin)Server-sideAdmin

Запрос

Получает список атрибутов из проекта для администрирования.

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

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

Пример: 44056
Запрос
limitinteger>= 1

Лимит количества элементов на странице.

Пример: limit=50
offsetinteger>= 0

Номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0).

Пример: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/attribute?limit=50&offset=0'

Ответы

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

Телоapplication/json
attributesArray of objects(admin_attribute_response)
Пример: [{"value":[{"external_id":"genre","name":{"de":"Genre","en":"Genre"}}]}]
total_countinteger
Ответ
application/json
{
  "attributes": [
    { … },
    { … }
  ],
  "total_count": 2
}

Создание атрибутаServer-sideAdmin

Запрос

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

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

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

Пример: 44056
Телоapplication/json
external_idstring(admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$обязательный

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

Пример: "attribute_1"
nameobject(admin-attribute-name)обязательный

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

По умолчанию {"de":"Genre","en":"Genre"}
Пример: {"de":"Genre","en":"Genre"}
name.​property name*stringдополнительное свойство
curl -i -X POST \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/attribute \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "genre",
    "name": {
      "de": "Genre",
      "en": "Genre"
    }
  }'

Ответы

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

Телоapplication/json
external_idstring(admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

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

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

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

Запрос

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

Внимание

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

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

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

External ID атрибута.

Пример: attribute_id
curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/attribute/attribute_id

Ответы

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

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