# Catalog API # Введение {% #overview %} - **Версия:** 2.0.0 - **Серверы:** `https://store.xsolla.com/api` - [Свяжитесь с нами по электронной почте](mailto:integration@xsolla.com) - **URL для связи:** https://xsolla.com/ - **Требуемая версия TLS:** 1.2 API каталога позволяет настраивать каталог внутриигровых товаров на стороне Xsolla и отображать каталог пользователям в вашем игровом магазине. API позволяет вам управлять такими сущностями каталога, как: * **Виртуальные предметы** — внутриигровые предметы, например оружие, скины, бустеры. * **Виртуальная валюта** — виртуальные деньги, которые используются для приобретения виртуальных товаров. * **Пакеты виртуальной валюты** — предустановленные наборы виртуальной валюты. * **Бандлы** — комбинированные наборы виртуальных предметов, валюты или игровых ключей, продаваемые как единый артикул. * **Игровые ключи** — ключи для игр и DLC, распространяемые через такие платформы, как Steam, или других DRM-провайдеров. * **Группы** — логические группировки для организации и сортировки товаров в каталоге. ## Методы API {% #api-calls %} Методы API делятся на следующие группы: * **Admin** — методы для создания, обновления, удаления и настройки товаров и групп каталога. Для вызова требуется [базовая HTTP-аутентификация](https://developers.xsolla.com/ru/payment-ui-and-flow/payment-ui/how-to-get-payment-token/#payments_solution_get_user_auth_token_basic_auth) с использованием учетных данных Личного кабинета. Не предназначены для построения витрин для конечных пользователей. * **Catalog** — методы для получения товаров и построения витрин для конечных пользователей. Поддерживают опциональную аутентификацию с использованием JWT пользователя для возврата персонализированных данных, таких как пользовательские лимиты и активные промоакции. # Аутентификация {% #authentication %} Методы API требуют аутентификации либо от имени пользователя, либо от имени проекта. Тип используемой схемы аутентификации указан в блоке **Безопасность** в описании каждого метода. ## Аутентификация с помощью JWT пользователя {% #authentication-using-users-jwt %} Аутентификация с помощью JWT пользователя применяется, когда запрос выполняется из браузера, мобильного приложения или игры. По умолчанию используется `XsollaLoginUserJWT`. Подробная информация о создании токена приведена в [документации Xsolla Login API](/ru/api/login/authentication-schemes#getting-user-token). Токен передается в заголовке `Authorization` в следующем формате: `Authorization: Bearer `, где `` — токен пользователя. Токен идентифицирует пользователя и обеспечивает доступ к персонализированным данным. В качестве альтернативы вы можете использовать [токен для открытия платежного интерфейса](/ru/api/pay-station/token/create-token). ## Базовая HTTP-аутентификация {% #basic-http-authentication %} Базовая HTTP-аутентификация применяется при взаимодействии server-to-server, когда вызов API отправляется напрямую с вашего сервера, а не из браузера пользователя или мобильного приложения. Обычно применяется базовая HTTP-аутентификация с использованием [ключа API](/ru/api/getting-started/#api_keys_overview).
Примечание

Ключ API является конфиденциальным и не должен храниться или использоваться в клиентских приложениях.
При базовой серверной аутентификации все запросы к API должны содержать заголовок: - для `basicAuth` — `Authorization: Basic `, где `your_authorization_basic_key` — это пара `project_id:api_key`, закодированная по стандарту Base64; - для `basicMerchantAuth` — `Authorization: Basic `, где `your_authorization_basic_key` — это пара `merchant_id:api_key`, закодированная по стандарту Base64. Значения параметров вы можете найти в [Личном кабинете](https://publisher.xsolla.com/): - `merchant_id` отображается: - В разделе **Настройки компании > Компания**. - В адресной строке браузера на любой странице Личного кабинета. URL-адрес имеет вид: `https://publisher.xsolla.com/`. - `project_id` отображается: - В Личном кабинете рядом с названием проекта. - В адресной строке браузера при работе с проектом в Личном кабинете. URL-адрес имеет вид: `https://publisher.xsolla.com//projects/`. - `api_key` отображается в Личном кабинете только при создании и должен храниться на вашей стороне. Создать ключ можно в разделах: - [Настройки компании > Ключи API](https://publisher.xsolla.com/0/settings/api_key) - [Настройки проекта > Ключи API](https://publisher.xsolla.com/0/projects/0/edit/api_key)
Внимание

Если необходимый метод API не включает в себя path-параметр project_id, используйте для авторизации ключ API, который действует во всех проектах.
Подробная информация о работе с ключами API приведена в [справочнике API](/ru/api/getting-started/#api_keys_overview). ## Аутентификация с поддержкой гостевого доступа {% #authentication-with-guest-access-support %} Для продажи корзины используется схема аутентификации `AuthForCart`, которая поддерживает два режима: 1. Аутентификация с помощью JWT пользователя. Токен передается в заголовке `Authorization` в следующем формате: `Authorization: Bearer `, где `` — токен пользователя. Токен идентифицирует пользователя и обеспечивает доступ к персонализированным данным. В качестве альтернативы вы можете использовать [токен для открытия платежного интерфейса](/ru/api/pay-station/token/create-token). 2. Упрощенный режим без заголовка. Он применяется только для неавторизованных пользователей и может быть использована только для [продажи игровых ключей](/ru/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users). Вместо токена в запрос передаются заголовки: - `x-unauthorized-id` с ID запроса; - `x-user` с email пользователя, закодированным в формате Base64. ## Полезные ссылки {% #authentication-useful-links %} - [Методы API по модели взаимодействия](/ru/api/getting-started/#api_interaction_model) - [Типы эндпоинтов](/ru/api/getting-started/#api_endpoint_types) - [Обработка ошибок](/ru/api/getting-started/#api_errors_handling) - [Управление ключами API](/ru/api/getting-started/#api_keys_overview) - [Вебхуки](/ru/webhooks/overview) # Базовая структура товара {% #core-entity-structure %} Товары всех типов (виртуальные предметы, бандлы, виртуальная валюта, ключи) используют схожую структуру данных. Понимание базовой структуры упрощает работу с API и позволяет быстрее ориентироваться в документации.
Примечание

В некоторых методах могут использоваться дополнительные поля, но они не изменяют базовую структуру.
**Идентификация** - `merchant_id` — ID компании в [Личном кабинете](https://publisher.xsolla.com/); - `project_id` — ID проекта в Личном кабинете; - `sku` — артикул товара, уникальный в рамках проекта. **Отображение в каталоге** - `name` — название; - `description` — описание; - `image_url` — ссылка на изображение; - `is_enabled` — доступность товара; - `is_show_in_store` — отображение в каталоге. Подробнее об управлении доступностью товаров в каталоге – в [документации](/ru/items-catalog/catalog-features/items-availability/). **Организация** - `type` — тип товара, например, виртуальный предмет (`virtual_item`) или бандл (`bundle`); - `groups` — группы, к которым относится товар; - `order` — порядок отображения в каталоге. **Условия продажи** - `prices` — цены в реальной или виртуальной валюте; - `limits` — ограничения на покупку; - `periods` — период доступности; - `regions` — региональные ограничения. **Пример базовой структуры:** ```json { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Main in-game currency" }, "image_url": "https://.../image.png", "name": { "en": "Crystals", "de": "Kristalle" }, "quantity": 500, "sku": "com.xsolla.crystal_2", "type": "virtual_currency" } ], "description": { "en": "Crystals x500" }, "groups": [], "image_url": "https://.../image.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Medium crystal pack" }, "order": 1, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 20, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_pack_2", "type": "bundle", "vc_prices": [] } ``` # Настройка продажи товаров {% #basic-purchase-flow %} Xsolla API позволяет реализовать логику магазина внутриигровых товаров,  включая получение каталога, управление корзиной, создание заказов и отслеживание их статусов. В зависимости от сценария интеграции методы API делятся на подразделы **Admin** и **Catalog**, которые используют разные [схемы аутентификации](/ru/api/catalog/authentication). Ниже приведен пример базового сценария настройки и работы магазина — от создания товаров до их продажи пользователю. ## Создание товаров и групп (Admin) {% #create-items-and-groups-admin %} Создайте каталог товаров для вашего магазина, например, виртуальные предметы, бандлы или виртуальную валюту. Примеры методов: - [Создать виртуальный предмет](/ru/api/catalog/virtual-items-currency-admin/admin-create-virtual-item) - [Создать бандл](/ru/api/catalog/bundles-admin/admin-create-bundle) - [Создать виртуальную валюту](/ru/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency) ## Настройка акций, цепочек, ограничений (Admin) {% #set-up-promotions-chains-and-limits-admin %} Настройте инструменты привлечения пользователей и монетизации, например скидки, бонусы, ежедневные награды или цепочки предложений. Примеры методов: - [Создать акцию с бонусами](/ru/api/liveops/promotions-bonuses/create-bonus-promotion) - [Создать ежедневную награду](/ru/api/liveops/daily-chain-admin/admin-create-daily-chain) - [Создать уникальное предложение по каталогу](/ru/api/liveops/promotions-unique-catalog-offers/admin-create-unique-catalog-offer) ## Получение информации о товарах (Client) {% #get-item-information-client %} Настройте отображение товаров магазина в вашем приложении.
Внимание

Не используйте методы подраздела Admin для построения каталога пользователям — у таких методов заданы ограничения по частоте запросов, которые не рассчитаны на пользовательский трафик.

Примеры методов: - [Получение списка виртуальных предметов](/ru/api/catalog/virtual-items-currency-catalog/get-virtual-items) - [Получение списка групп товаров](/ru/api/catalog/virtual-items-currency-catalog/get-item-groups) - [Получение списка бандлов](/ru/api/catalog/bundles-catalog/get-bundle-list) - [Получение списка продаваемых товаров](/ru/api/catalog/common-catalog/get-sellable-items)
Примечание

По умолчанию в методах получения каталога возвращаются товары, которые отображаются в магазине на момент запроса. Чтобы получить информацию о товарах, период отображения которых еще не наступил или уже истек, передайте параметр "show_inactive_time_limited_items": 1 при запросе каталога.
## Продажа товаров {% #sell-items %} Вы можете продавать товары за реальную валюту следующими способами: - Быстрая покупка — продажа одного товара, но в любом количестве. - Покупка корзины — пользователь наполняет корзину, добавляет и удаляет товары, изменяет количество в одном заказе. Если товар оплачивается внутриигровой валютой, а не реальными деньгами, используйте метод [Создание заказа с указанным товаром, приобретенным за виртуальную валюту](/ru/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency). Платежный интерфейс открывать не нужно — списание происходит в момент вызова метода. Если товар бесплатный, используйте метод [Создание заказа с указанным бесплатным товаром](/ru/api/catalog/free-item/create-free-order-with-item) или метод [Создание заказа с помощью бесплатной корзины](/ru/api/catalog/free-item/create-free-order). Платежный интерфейс открывать не нужно — заказ сразу переходит в статус done. ### Быстрая покупка {% #fast-purchase %} Используйте клиентский [метод создания заказа с указанным товаром](/ru/api/catalog/payment-client-side/create-order-with-item) – в ответе вы получите токен, который используется для открытия платежного интерфейса.
Примечание

Информация о скидке доступна пользователю только в платежном интерфейсе. Использование промокодов не предусмотрено.
### Покупка корзины {% #cart-purchase %} Наполнение и покупка корзины может осуществляться на клиенте или на сервере. **Наполнение и покупка корзины на клиенте** Самостоятельно реализуйте логику добавления и удаления товаров. Также необходимо учитывать, что до вызова метода наполнения корзины у вас не будет информации о том, какие акции будут применены при покупке. Это означает, что итоговая стоимость и сведения о добавленных бонусных предметах будут неизвестны. Реализуйте следующую логику работы с корзиной: 1. После наполнения корзины игроком используйте метод [Наполнение корзины товарами](/ru/api/shop-builder/operation/cart-fill/) для наполнения корзины. В ответе вернется текущая информация о выбранных товарах — цены до и после применения скидок, бонусные товары. 2. Обновите содержимое корзины в соответствии с действиями пользователя: - Для добавления товара или изменения его количества используйте метод [Обновление товара в корзине по ID корзины](/ru/api/shop-builder/operation/put-item-by-cart-id/). - Для удаления товара используйте метод [Удаление товара из корзины по ID корзины](/ru/api/shop-builder/operation/delete-item-by-cart-id/).
Примечание

Если вы хотите получить актуальное состояние корзины, используйте метод Получение корзины текущего пользователя.
3. Используйте метод покупки корзины [Создание заказа со всеми товарами из текущей корзины](/ru/api/shop-builder/operation/create-order/). В ответе вернутся ID заказа и платежный токен. Заказу будет присвоен статус new. **Наполнение и покупка корзины на сервере** Этот вариант наполнения корзины может занимать значительное время на настройку, поскольку каждое изменение корзины может сопровождаться вызовом большего количества методов API. Реализуйте следующую логику работы с корзиной: 1. После наполнения корзины игроком используйте методс [Наполнение корзины товарами](/ru/api/catalog/cart-server-side)для наполнения корзины. В ответе вернется текущая информация о выбранных товарах — цены до и после применения скидок, бонусные товары. 2. Используйте метод покупки корзины [Создание заказа со всеми товарами из текущей корзины](/ru/api/shop-builder/operation/create-order/). В ответе вернутся ID заказа и платежный токен. Заказу будет присвоен статус new. ## Открытие платежного интерфейса {% #open-payment-ui %} Используйте полученный токен для открытия платежного интерфейса в новом окне. Другие способы открытия платежного интерфейса описаны в [документации](/ru/payment-ui-and-flow/payment-ui/how-to-open-payment-ui/#open_payment_ui). | Действие | Эндпоинт | |:----------------------------------|:--------------------------------------------------------------------------| | Открыть в боевом окружении. | https://secure.xsolla.com/paystation4/?token={token} | | Открыть в тестовом окружении. | https://sandbox-secure.xsolla.com/paystation4/?token={token} |
Примечание

Используйте тестовый режим (sandbox-режим) при разработке и тестировании — при совершении тестовой покупки с реальных счетов не списываются деньги. Для тестирования вы можете использовать тестовые банковские карты. После проведения первого реального платежа в силу вступает строгая политика платежей в тестовом окружении. Проведение платежа в нем будет доступно только для пользователей, которые указаны в Личном кабинете в разделе [Настройки компании > Пользователи](https://publisher.xsolla.com/0/settings/users). Покупка виртуальной валюты и виртуальных предметов за реальную валюту возможна после подписания лицензионного договора с Xsolla. Для этого в [Личном кабинете](https://publisher.xsolla.com/) перейдите в **Договоры и налоги > Договоры**, заполните договор и дождитесь подтверждения согласования. Согласование может занять до 3 рабочих дней.
Для включения или отключения тестового режима вам необходимо изменить значение параметра `sandbox` в теле запроса методов быстрой покупки и покупки корзины. По умолчанию тестовый режим выключен. Возможные статусы заказа: - `new` — заказ создан; - `paid` — оплата получена; - `done` — товар начислен; - `canceled` — заказ отменен; - `expired` — истек срок оплаты. Отслеживайте статус одним из следующих способов: - через [настройку вебхуков](/ru/virtual-goods/own-ui/server-side-token-generation/set-up-order-tracking/#payments_integration_order_tracking) на сервере вашего приложения; - через [простые запросы ](/ru/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/#guides_shop_builder_integrate_store_get_order_status_via_short_polling)(short-polling); - [WebSocket API](/ru/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/#guides_shop_builder_integrate_store_get_order_status_via_websocket_api). ## Полезные ссылки {% #basic-purchase-flow-useful-links %} - Аутентификация - [Методы API по модели взаимодействия](/ru/api/catalog/authentication) - [Тестирование платежей](/ru/dev-resources/testing/general-info/#general_overview) - [Отслеживание статуса заказа](/ru/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/?link=200-api#payments_integration_order_tracking) - [Вебхуки](/ru/webhooks/overview) - [Ограничения скорости запросов](/ru/api/login/rate-limits) - [Обработка ошибок](/ru/api/getting-started/#api_errors_handling) - [Управление ключами API](/ru/api/getting-started/#api_keys_overview) # Пагинация {% #pagination %} Методы API для запроса большого количества записей (например, для построения каталога) возвращают данные постранично. Пагинация — это механизм ограничения количества элементов, возвращаемых в одном ответе API, с возможностью последовательного получения следующих страниц. Для управления количеством возвращаемых элементов используйте следующие параметры: - `limit` — количество элементов на странице; - `offset` — номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0); - `has_more` — есть ли следующая страница; - `total_items_count` — общее количество элементов. Пример запроса: ``` GET /items?limit=20&offset=40 ``` Пример ответа: ```json { "items": [...], "has_more": true, "total_items_count": 135 } ``` Рекомендуется выполнять последовательные запросы до тех пор, пока в ответе не вернется `has_more = false`. # Формат даты и времени {% #date-and-time-format %} Дата и время передаются в формате [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). Поддерживаются: - смещение относительно UTC; - значение `null`, когда нет ограничения времени отображения предмета; - в отдельных полях используется [Unix timestamp](https://www.unixtimestamp.com/) (в секундах). Формат: `YYYY-MM-DDTHH:MM:SS±HH:MM` Пример: `2026-03-16T10:00:00+03:00` # Локализация {% #localization %} Xsolla поддерживает локализацию пользовательских полей, таких как название и описание товаров. Локализованные значения передаются в виде объекта, в котором ключом является код языка. Полный список поддерживаемых языков приведен в [документации](/ru/doc/shop-builder/references/supported-languages/). **Поддерживаемые поля** Локализация может быть задана для следующих параметров: - `name` - `description` - `long_description` **Формат локали** Ключ локали может быть указан в одном из следующих форматов: - двухбуквенный код языка: `en`, `ru` - формат язык–страна: `en-US`, `ru-RU`, `de-DE` **Примеры** Пример с двухбуквенным кодом языка: ```json { "name": { "en": "Starter Pack", "ru": "Стартовый набор" } } ``` Пример с форматом язык–страна: ```json { "description": { "en-US": "Premium bundle", "de-DE": "Premium-Paket" } } ``` # Определение страны и валюты {% #country-and-currency-determination %} Страна пользователя определяет цены в каталоге, валюту оплаты и доступные способы оплаты в платежном интерфейсе. В зависимости от метода API страна определяется следующим образом:
  • В клиентских методах, страна определяется по IP-адресу запроса.
  • В серверных методах, страна определяется по значению параметра user.country.value или по IP-адресу пользователя из заголовка X-User-Ip. Если переданы оба значения, приоритет имеет параметр user.country.value.
Примечание

Для определения страны поддерживаются только IPv4-адреса. Передача IPv6-адреса может привести к некорректному определению страны и валюты. Если вы используете серверный метод и не можете передать IPv4-адрес пользователя, передайте страну явно в параметре user.country.value.
# Формат ответа при ошибке {% #error-response-format %} При возникновении ошибки API возвращает HTTP-статус и тело ответа в формате JSON. Полный список ошибок в работе магазина приведен в [документации](/ru/dev-resources/references/errors/store-errors/). **Пример ответа:** ```json { "errorCode": 1102, "errorMessage": "Validation error", "statusCode": 422, "transactionId": "c9e1a..." } ``` - `errorCode` — код ошибки. - `errorMessage` — краткое описание ошибки. - `statusCode` — HTTP статус ответа. - `transactionId` — ID запроса. Возвращается не во всех случаях. - `errorMessageExtended` — дополнительные данные об ошибке, например параметры запроса. Возвращаются не во всех случаях. **Пример расширенного ответа:** ```json { "errorCode": 7001, "errorMessage": "Chain not found", "errorMessageExtended": { "chain_id": "test_chain_id", "project_id": "test_project_id", "step_number": 2 }, "statusCode": 404 } ``` **Частые HTTP-статусы** - `400` — некорректный запрос - `401` — ошибка аутентификации - `403` — недостаточно прав доступа - `404` — ресурс не найден - `422` — ошибка валидации данных - `429` — превышено ограничение частоты запросов **Рекомендации** - Обрабатывайте HTTP-статус и тело ответа совместно. - Используйте `errorCode` для обработки ошибок, связанных с логикой работы приложения. - Используйте `transactionId`, чтобы быстрее идентифицировать запросы при анализе ошибок. Version: 2.0.0 ## Servers ``` https://store.xsolla.com/api ``` ## Security ### basicAuth Для серверных методов используется схема аутентификации `basicAuth`. Все запросы к API должны содержать заголовок `Authorization: Basic `, где `your_authorization_basic_key` — пара `project_id:api_key`, закодированная по стандарту Base64. Вы можете использовать `merchant_id` вместо `project_id` при необходимости. Это не влияет на функциональность. Значения параметров вы можете найти в [Личном кабинете](https://publisher.xsolla.com/): * `merchant_id` отображается: * В разделе **Настройки компании > Компания** * В адресной строке браузера на любой странице Личного кабинета. URL-адрес имеет вид: `https://publisher.xsolla.com/`. * `api_key` отображается в Личном кабинете только при создании и должен храниться на вашей стороне. Создать ключ можно в разделах: * [Настройки компании > Ключи API](https://publisher.xsolla.com/0/settings/api_key) * [Настройки проекта > Ключи API](https://publisher.xsolla.com/0/projects/0/edit/api_key) {% html name="div" attrs={"class": "notice"} %} **Внимание** Если необходимый метод API не включает в себя path-параметр `project_id`, используйте для авторизации ключ API, который действует во всех проектах. {% /html %} * `project_id` отображается: * В Личном кабинете рядом с названием проекта. * В адресной строке браузера при работе с проектом в Личном кабинете. URL-адрес имеет вид: `https://publisher.xsolla.com//projects/`. Подробная информация о работе с ключами API приведена в [справочнике API](https://developers.xsolla.com/ru/api/getting-started/#api_keys_overview). Type: http Scheme: basic ### XsollaLoginUserJWT Для клиентских методов используется схема аутентификации `XsollaLoginUserJWT`. Запрос должен содержать JWT пользователя в заголовке `Authorization` в формате Bearer ``. Токен идентифицирует пользователя и обеспечивает доступ к персонализированным данным. Подробная информация о создании токена приведена в [документации Xsolla Login API](/ru/api/login/authentication-schemes#getting-user-token). В качестве альтернативы вы можете использовать [токен для открытия платежного интерфейса](/ru/api/pay-station/token/create-token). Type: http Scheme: bearer Bearer Format: JWT ### AuthForCart Для продажи корзины используется схема аутентификации `AuthForCart`, которая поддерживает два режима: 1. Аутентификация с использованием JWT пользователя. Токен передается в заголовке Authorization в следующем формате: `Authorization: Bearer `, где `` — это токен пользователя. Токен идентифицирует пользователя и предоставляет доступ к персонализированным данным. В качестве альтернативы вы можете использовать [токен для открытия платежного интерфейса](/ru/api/pay-station/token/create-token). 2. Упрощенный режим без заголовка `Authorization`. Он применяется только для неавторизованных пользователей и может быть использована только для [продажи игровых ключей](/ru/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users). Вместо токена в запрос передаются специальные заголовки: * `x-unauthorized-id` с ID запроса; * `x-user` с email пользователя, закодированным по стандарту Base64. Type: http Scheme: bearer ### basicMerchantAuth Для серверных методов используется схема аутентификации `basicMerchantAuth`. Все запросы к API должны содержать заголовок `Authorization: Basic `, где `your_authorization_basic_key` — пара `merchant_id:api_key`, закодированная по стандарту Base64. Значения параметров вы можете найти в [Личном кабинете](https://publisher.xsolla.com/): * `merchant_id` отображается: * В разделе **Настройки компании > Компания** * В адресной строке браузера на любой странице Личного кабинета. URL-адрес имеет вид: `https://publisher.xsolla.com/` * `api_key` отображается в Личном кабинете только при создании и должен храниться на вашей стороне. Создать ключ можно в разделе [Настройки компании > Ключи API](https://publisher.xsolla.com/0/settings/api_key). Подробная информация о работе с ключами API приведена в [справочнике API](https://developers.xsolla.com/ru/api/getting-started/#api_keys_overview). Type: http Scheme: basic ## Download OpenAPI description [Catalog API](https://xsolla.redocly.app/_bundle/@l10n/ru/api/catalog/index.yaml) ## Admin ### Получение списка виртуальных предметов - [GET /v2/project/{project_id}/admin/items/virtual_items](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list.md): Получает список виртуальных предметов в рамках проекта для администрирования. ПримечаниеНе используйте данный метод для построения каталога магазина. ### Создание виртуального предмета - [POST /v2/project/{project_id}/admin/items/virtual_items](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-admin/admin-create-virtual-item.md): Создает виртуальный предмет. ### Получение списка виртуальных предметов по указанному External ID группы - [GET /v2/project/{project_id}/admin/items/virtual_items/group/external_id/{external_id}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list-by-group-external-id.md): Получает список виртуальных предметов в рамках группы для администрирования. ПримечаниеНе используйте данный метод для построения каталога магазина. ### Получение списка виртуальных предметов по указанному ID группы - [GET /v2/project/{project_id}/admin/items/virtual_items/group/id/{group_id}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list-by-group-id.md): Получает список виртуальных предметов в рамках группы для администрирования. ПримечаниеНе используйте данный метод для построения каталога магазина. ### Получение виртуального предмета - [GET /v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-admin/admin-get-virtual-item.md): Получает виртуальный предмет в рамках проекта для администрирования. ПримечаниеНе используйте данный метод для построения каталога магазина. ### Обновление виртуального предмета - [PUT /v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-admin/admin-update-virtual-item.md): Обновляет виртуальный предмет. ### Удаление виртуального предмета - [DELETE /v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-admin/admin-delete-virtual-item.md): Удаляет виртуальный предмет. ### Получение списка виртуальных валют - [GET /v2/project/{project_id}/admin/items/virtual_currency](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-admin/admin-get-virtual-currencies-list.md): Получает список виртуальных валют в рамках проекта для администрирования. ПримечаниеНе используйте данный метод для построения каталога магазина. ### Создание виртуальной валюты - [POST /v2/project/{project_id}/admin/items/virtual_currency](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency.md): Создает виртуальную валюту. ### Получение виртуальной валюты - [GET /v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-admin/admin-get-virtual-currency.md): Получает виртуальную валюту в рамках проекта для администрирования. ПримечаниеНе используйте данный метод для построения каталога магазина. ### Обновление виртуальной валюты - [PUT /v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-admin/admin-update-virtual-currency.md): Обновляет виртуальную валюту. ### Удаление виртуальной валюты - [DELETE /v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-admin/admin-delete-virtual-currency.md): Удаляет виртуальную валюту. ### Получение списка пакетов виртуальной валюты (admin) - [GET /v2/project/{project_id}/admin/items/virtual_currency/package](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-admin/admin-get-virtual-currency-packages-list.md): Получает список пакетов виртуальной валюты в рамках проекта для администрирования. ПримечаниеНе используйте данный метод для построения каталога магазина. ### Создание пакета виртуальной валюты - [POST /v2/project/{project_id}/admin/items/virtual_currency/package](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency-package.md): Создает пакет виртуальной валюты. ### Обновление пакета виртуальной валюты - [PUT /v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-admin/admin-update-virtual-currency-package.md): Обновляет пакет виртуальной валюты. ### Удаление пакета виртуальной валюты - [DELETE /v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-admin/admin-delete-virtual-currency-package.md): Удаляет пакет виртуальной валюты. ### Получение пакета виртуальной валюты - [GET /v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-admin/admin-get-virtual-currency-package.md): Получает пакет виртуальной валюты в рамках проекта для администрирования. ПримечаниеНе используйте данный метод для построения каталога магазина. ## Catalog ### Получение списка виртуальных предметов - [GET /v2/project/{project_id}/items/virtual_items](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-catalog/get-virtual-items.md): Получает список виртуальных предметов для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. См. также: Метод Получение списка всех виртуальных предметов для поиска и индексирования на стороне клиента. ### Получение виртуального предмета по артикулу - [GET /v2/project/{project_id}/items/virtual_items/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-catalog/get-virtual-items-sku.md): Получает виртуальный предмет по артикулу для построения каталога. Внимание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение списка всех виртуальных предметов - [GET /v2/project/{project_id}/items/virtual_items/all](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-catalog/get-all-virtual-items.md): Возвращает список всех виртуальных предметов для поиска на стороне клиента. Внимание Возвращаются только артикул товара, название, группы и описание. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. См. также: Метод Получение списка всех виртуальных предметов для поиска и индексирования на стороне клиента. ### Получение списка виртуальных валют - [GET /v2/project/{project_id}/items/virtual_currency](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-catalog/get-virtual-currency.md): Получает список виртуальных валют для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение виртуальной валюты по артикулу - [GET /v2/project/{project_id}/items/virtual_currency/sku/{virtual_currency_sku}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-catalog/get-virtual-currency-sku.md): Получает виртуальную валюту по артикулу для построения каталога. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение списка пакетов виртуальной валюты - [GET /v2/project/{project_id}/items/virtual_currency/package](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package.md): Получает список пакетов виртуальной валюты для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение пакета виртуальной валюты по артикулу - [GET /v2/project/{project_id}/items/virtual_currency/package/sku/{virtual_currency_package_sku}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package-sku.md): Получает пакет виртуальной валюты по артикулу для построения каталога. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение списка товаров по указанной группе - [GET /v2/project/{project_id}/items/virtual_items/group/{external_id}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-catalog/get-virtual-items-group.md): Получает список товаров из указанной группы для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение списка виртуальных валют по указанной группе - [GET /v2/project/{project_id}/items/virtual_currency/group/{external_id}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-catalog/get-virtual-currency-group.md): Возвращает список виртуальных валют из указанной группы для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение списка пакетов виртуальных валют по указанной группе - [GET /v2/project/{project_id}/items/virtual_currency/package/group/{external_id}](https://xsolla.redocly.app/ru/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package-group.md): Возвращает список пакетов виртуальной валюты из указанной группы для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ## Виртуальная оплата ### Создание заказа с указанным товаром, приобретенным за виртуальную валюту - [POST /v2/project/{project_id}/payment/item/{item_sku}/virtual/{virtual_currency_sku}](https://xsolla.redocly.app/ru/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency.md): Создает покупку товара с использованием виртуальной валюты. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ## Catalog ### Получение списка игр - [GET /v2/project/{project_id}/items/game](https://xsolla.redocly.app/ru/api/catalog/game-keys-catalog/get-games-list.md): Получает список игр для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение списка игр по указанной группе - [GET /v2/project/{project_id}/items/game/group/{external_id}](https://xsolla.redocly.app/ru/api/catalog/game-keys-catalog/get-games-group.md): Получает список игр из указанной группы для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение игры для каталога - [GET /v2/project/{project_id}/items/game/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/game-keys-catalog/get-game-by-sku.md): Получает игру для каталога. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение игрового ключа для каталога - [GET /v2/project/{project_id}/items/game/key/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/game-keys-catalog/get-game-key-by-sku.md): Получает иговой ключ для каталога. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение списка игровых ключей по указанной группе - [GET /v2/project/{project_id}/items/game/key/group/{external_id}](https://xsolla.redocly.app/ru/api/catalog/game-keys-catalog/get-game-keys-group.md): Получает список игровых ключей из указанной группы для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение списка платформ - [GET /v2/project/{project_id}/items/game/drm](https://xsolla.redocly.app/ru/api/catalog/game-keys-catalog/get-drm-list.md): Получает список доступных платформ. ## Владение играми ### Получение списка игр, принадлежащих пользователю - [GET /v2/project/{project_id}/entitlement](https://xsolla.redocly.app/ru/api/catalog/game-keys-entitlement/get-user-games.md): Получает список игр, принадлежащих пользователю. Ответ будет содержать массив игр, принадлежащих определенному пользователю. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Активация игрового ключа на стороне клиента - [POST /v2/project/{project_id}/entitlement/redeem](https://xsolla.redocly.app/ru/api/catalog/game-keys-entitlement/redeem-game-pin-code.md): Дает право владения по предоставленному игровому коду. Обратите внимание Вы можете активировать коды только для платформы без DRM. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Предоставление права владения (admin) - [POST /v2/project/{project_id}/admin/entitlement/grant](https://xsolla.redocly.app/ru/api/catalog/game-keys-entitlement/grant-entitlement-admin.md): Дает пользователю право владения. ВниманиеМогут быть предоставлены только игровые ключи или игры для DRM-free-платформ. ### Отзыв права владения (admin) - [POST /v2/project/{project_id}/admin/entitlement/revoke](https://xsolla.redocly.app/ru/api/catalog/game-keys-entitlement/revoke-entitlement-admin.md): Отзывает право владения у пользователя. ВниманиеМогут быть отозваны только игровые ключи или игры для DRM-free-платформ. ## Admin ### Создание игры - [POST /v2/project/{project_id}/admin/items/game](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-create-game.md): Создает игру в проекте. ### Получение списка игр (admin) - [GET /v2/project/{project_id}/admin/items/game](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-get-game-list.md): Получает список игр в рамках проекта для администрирования. Игра состоит из игровых ключей, которые могут быть приобретены пользователем. ПримечаниеНе используйте данный метод для построения каталога магазина. ### Получение игры (admin) - [GET /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-get-game-by-sku.md): Получает игру для администрирования. Игра состоит из игровых ключей, которые могут быть приобретены пользователем. ПримечаниеНе используйте данный метод для построения каталога магазина. ### Обновление игры по артикулу - [PUT /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-update-game-by-sku.md): Обновляет игру в проекте по артикулу. ### Удаление игры по артикулу - [DELETE /v2/project/{project_id}/admin/items/game/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-delete-game-by-sku.md): Удаляет игру в проекте по артикулу. ### Получение игры по ID (admin) - [GET /v2/project/{project_id}/admin/items/game/id/{item_id}](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-get-game-by-id.md): Получает игру для администрирования. Игра состоит из игровых ключей, которые могут быть приобретены пользователем. ПримечаниеНе используйте данный метод для построения каталога магазина. ### Обновление игры по ID - [PUT /v2/project/{project_id}/admin/items/game/id/{item_id}](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-update-game-by-id.md): Обновляет игру в проекте по ID. ### Удаление игры по ID - [DELETE /v2/project/{project_id}/admin/items/game/id/{item_id}](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-delete-game-by-id.md): Удаляет игру в проекте по ID. ### Загрузка кодов - [POST /v2/project/{project_id}/admin/items/game/key/upload/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-upload-codes-by-sku.md): Загружает коды по артикулу игрового ключа. ### Загрузка кодов по ID - [POST /v2/project/{project_id}/admin/items/game/key/upload/id/{item_id}](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-upload-codes-by-id.md): Загружает коды по ID игрового ключа. ### Получение информации о сеансе загрузки кодов - [GET /v2/project/{project_id}/admin/items/game/key/upload/session/{session_id}](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-get-codes-session.md): Получает информацию о сеансе загрузки кодов. ### Получение кодов - [GET /v2/project/{project_id}/admin/items/game/key/request/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-get-codes-by-sku.md): Получает определенное количество кодов по артикулу игрового ключа. ### Получение кодов по ID - [GET /v2/project/{project_id}/admin/items/game/key/request/id/{item_id}](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-get-codes-by-id.md): Получает определенное количество кодов по ID игрового ключа. ### Удаление кодов - [DELETE /v2/project/{project_id}/admin/items/game/key/delete/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-delete-codes-by-sku.md): Удаляет все коды по артикулу игрового ключа. ### Удаление кодов по ID - [DELETE /v2/project/{project_id}/admin/items/game/key/delete/id/{item_id}](https://xsolla.redocly.app/ru/api/catalog/game-keys-admin/admin-delete-codes-by-id.md): Удаляет все коды по ID игрового ключа. ## Admin ### Получение списка бандлов - [GET /v2/project/{project_id}/admin/items/bundle](https://xsolla.redocly.app/ru/api/catalog/bundles-admin/admin-get-bundle-list.md): Получает список бандлов в рамках проекта для администрирования. ПримечаниеНе используйте данный метод для построения каталога магазина. ### Создание бандла - [POST /v2/project/{project_id}/admin/items/bundle](https://xsolla.redocly.app/ru/api/catalog/bundles-admin/admin-create-bundle.md): Создает бандл — набор товаров, который продается как единое целое. В состав бандла можно добавить виртуальные предметы, пакеты виртуальной валюты, игровые ключи и другие бандлы. Подробная информация о работе с бандлами приведена в разделе Бандлы. Внимание. Все товары, перечисленные в массиве content, должны быть созданы в вашем проекте заранее. Если указанный артикул не существует, система вернет ошибку. ### Получение списка бандлов по указанному ID группы - [GET /v2/project/{project_id}/admin/items/bundle/group/id/{group_id}](https://xsolla.redocly.app/ru/api/catalog/bundles-admin/admin-get-bundle-list-in-group-by-id.md): Получает список бандлов в рамках группы для администрирования. ПримечаниеНе используйте данный метод для построения каталога магазина. ### Получение списка бандлов по указанному External ID группы - [GET /v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}](https://xsolla.redocly.app/ru/api/catalog/bundles-admin/admin-get-bundle-list-in-group-by-external-id.md): Получает список бандлов в рамках группы для администрирования. ПримечаниеНе используйте данный метод для построения каталога магазина. ### Обновление бандла - [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://xsolla.redocly.app/ru/api/catalog/bundles-admin/admin-update-bundle.md): Обновляет бандл. Метод полностью заменяет бандл — передайте все обязательные поля в теле запроса, а не только те, которые необходимо изменить. Подробная информация о работе с бандлами приведена в разделе Бандлы. Внимание. Все товары, перечисленные в массиве content, должны быть созданы в вашем проекте заранее. Если указанный артикул не существует, система вернет ошибку. ### Удаление бандла - [DELETE /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://xsolla.redocly.app/ru/api/catalog/bundles-admin/admin-delete-bundle.md): Удаляет бандл. ### Получение бандла - [GET /v2/project/{project_id}/admin/items/bundle/sku/{sku}](https://xsolla.redocly.app/ru/api/catalog/bundles-admin/admin-get-bundle.md): Получает бандл в рамках проекта для администрирования. ПримечаниеНе используйте данный метод для построения каталога магазина. ### Отображение бандла в каталоге - [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}/show](https://xsolla.redocly.app/ru/api/catalog/bundles-admin/admin-show-bundle.md): Показывает бандл в каталоге. ### Скрытие бандла в каталоге - [PUT /v2/project/{project_id}/admin/items/bundle/sku/{sku}/hide](https://xsolla.redocly.app/ru/api/catalog/bundles-admin/admin-hide-bundle.md): Скрывает бандл в каталоге. ## Catalog ### Получение списка бандлов - [GET /v2/project/{project_id}/items/bundle](https://xsolla.redocly.app/ru/api/catalog/bundles-catalog/get-bundle-list.md): Получает список бандлов для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение указанного бандла - [GET /v2/project/{project_id}/items/bundle/sku/{sku}](https://xsolla.redocly.app/ru/api/catalog/bundles-catalog/get-bundle.md): Получает указанный бандл. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение списка бандлов по указанной группе - [GET /v2/project/{project_id}/items/bundle/group/{external_id}](https://xsolla.redocly.app/ru/api/catalog/bundles-catalog/get-bundle-list-in-group.md): Получает список бандлов в рамках группы для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ## Корзина (на стороне клиента) Используйте методы из этого подраздела для управления корзиной на стороне клиента. ### Получение корзины по ID корзины - [GET /v2/project/{project_id}/cart/{cart_id}](https://xsolla.redocly.app/ru/api/catalog/cart-client-side/get-cart-by-id.md): Возвращает корзину пользователя по ID корзины. ### Получение корзины текущего пользователя - [GET /v2/project/{project_id}/cart](https://xsolla.redocly.app/ru/api/catalog/cart-client-side/get-user-cart.md): Возвращает корзину текущего пользователя. ### Удаление всех товаров из корзины по ID корзины - [PUT /v2/project/{project_id}/cart/{cart_id}/clear](https://xsolla.redocly.app/ru/api/catalog/cart-client-side/cart-clear-by-id.md): Удаляет все товары из корзины. ### Удаление всех товаров из текущей корзины - [PUT /v2/project/{project_id}/cart/clear](https://xsolla.redocly.app/ru/api/catalog/cart-client-side/cart-clear.md): Удаляет все товары из корзины. ### Наполнение корзины товарами - [PUT /v2/project/{project_id}/cart/fill](https://xsolla.redocly.app/ru/api/catalog/cart-client-side/cart-fill.md): Наполняет корзину товарами. Если в корзине уже есть товар с тем же артикулом, существующий товар будет заменен переданным значением. ### Наполнение определенной корзины товарами - [PUT /v2/project/{project_id}/cart/{cart_id}/fill](https://xsolla.redocly.app/ru/api/catalog/cart-client-side/cart-fill-by-id.md): Наполняет определенную корзину товарами. Если в корзине уже есть товар с тем же артикулом, существующая позиция товара будет заменен переданным значением. ### Обновление товара в корзине по ID корзины - [PUT /v2/project/{project_id}/cart/{cart_id}/item/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/cart-client-side/put-item-by-cart-id.md): Обновляет уже имеющийся в корзине товар или создает его в корзине. ### Удаление товара из корзины по ID корзины - [DELETE /v2/project/{project_id}/cart/{cart_id}/item/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/cart-client-side/delete-item-by-cart-id.md): Удаляет товар из корзины. ### Обновление товара из текущей корзины - [PUT /v2/project/{project_id}/cart/item/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/cart-client-side/put-item.md): Обновляет уже имеющийся в корзине товар или создает его в корзине. ### Удаление товара из текущей корзины - [DELETE /v2/project/{project_id}/cart/item/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/cart-client-side/delete-item.md): Удаляет товар из корзины. ## Корзина (на стороне сервера) Используйте методы из этого подраздела для управления корзиной на стороне сервера. ### Наполнение корзины товарами - [PUT /v2/admin/project/{project_id}/cart/fill](https://xsolla.redocly.app/ru/api/catalog/cart-server-side/admin-cart-fill.md): Заполняет текущую корзину товарами. Если в корзине уже есть товар с таким же артикулом, существующий товар будет заменен на переданное значение. ### Наполнение корзины по ID корзины товарами - [PUT /v2/admin/project/{project_id}/cart/{cart_id}/fill](https://xsolla.redocly.app/ru/api/catalog/cart-server-side/admin-fill-cart-by-id.md): Заполняет корзину товарами по идентификатору корзины. Если в корзине уже есть товар с таким же артикулом, существующий товар будет заменен на переданное значение. ## Оплата (на стороне клиента) Используйте методы из этого подраздела для формирования платежного токена на стороне клиента. ### Создание заказа со всеми товарами из определенной корзины - [POST /v2/project/{project_id}/payment/cart/{cart_id}](https://xsolla.redocly.app/ru/api/catalog/payment-client-side/create-order-by-cart-id.md): Используется для интеграции клиент-сервер. Создает заказ со всеми товарами из конкретной корзины и генерирует для него токен оплаты. Созданный заказ получает статус заказа new. IP-адрес клиента используется для определения страны пользователя, которая затем используется для применения соответствующей валюты и доступных способов оплаты заказа. Чтобы открыть платежный интерфейс в новом окне, воспользуйтесь следующей ссылкой: https://secure.xsolla.com/paystation4/?token={token}, где {token} — полученный токен. Для целей тестирования используйте этот URL-адрес: https://sandbox-secure.xsolla.com/paystation4/?token={token}. Внимание Поскольку этот метод использует IP-адрес для определения страны пользователя и валюты для заказа, важно использовать этот метод только на стороне клиента, а не на стороне сервера. Использование этого метода на стороне сервера может привести к неправильному определению валюты и повлиять на способы оплаты в Pay Station. ### Создание заказа со всеми товарами из текущей корзины - [POST /v2/project/{project_id}/payment/cart](https://xsolla.redocly.app/ru/api/catalog/payment-client-side/create-order.md): Используется для интеграции клиент-сервер. Создает заказ со всеми товарами из корзины и генерирует для него токен оплаты. Созданный заказ получает new статус заказа. IP-адрес клиента используется для определения страны пользователя, которая затем используется для применения соответствующей валюты и доступных способов оплаты заказа. Чтобы открыть платежный интерфейс в новом окне, воспользуйтесь следующей ссылкой: https://secure.xsolla.com/paystation4/?token={token}, где {token} — полученный токен. Для целей тестирования используйте этот URL-адрес: https://sandbox-secure.xsolla.com/paystation4/?token={token}. Внимание Поскольку этот метод использует IP-адрес для определения страны пользователя и валюты для заказа, важно использовать этот метод только на стороне клиента, а не на стороне сервера. Использование этого метода на стороне сервера может привести к неправильному определению валюты и повлиять на способы оплаты в Pay Station. ### Создание заказа с указанным товаром - [POST /v2/project/{project_id}/payment/item/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/payment-client-side/create-order-with-item.md): Используется для интеграции клиент-сервер. Создает заказ с указанным товаром и генерирует для него токен оплаты. Созданный заказ получает статус заказа new. IP-адрес клиента используется для определения страны пользователя, которая затем используется для применения соответствующей валюты и доступных способов оплаты заказа. Чтобы открыть платежный интерфейс в новом окне, воспользуйтесь следующей ссылкой: https://secure.xsolla.com/paystation4/?token={token}, где {token} — полученный токен. Для целей тестирования используйте этот URL-адрес: https://sandbox-secure.xsolla.com/paystation4/?token={token}. Внимание Поскольку этот метод использует IP-адрес для определения страны пользователя и валюты для заказа, важно использовать этот метод только на стороне клиента, а не на стороне сервера. Использование этого метода на стороне сервера может привести к неправильному определению валюты и повлиять на способы оплаты в Pay Station. Уведомление Этот метод использует JWT пользователя для авторизации. Передайте токен в заголовке Authorization в формате Bearer <user_JWT>. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ## Оплата (на стороне сервера) Используйте методы из этого подраздела для формирования платежного токена на стороне сервера. ### Создание платежного токена для покупки - [POST /v3/project/{project_id}/admin/payment/token](https://xsolla.redocly.app/ru/api/catalog/payment-server-side/admin-create-payment-token.md): Генерирует заказ и платежный токен для него. Заказ генерируется на основе товаров, переданных в теле запроса. Чтобы открыть платежный интерфейс в новом окне, воспользуйтесь следующей ссылкой: https://secure.xsolla.com/paystation4/?token={token}, где {token} — полученный токен. Для целей тестирования используйте этот URL-адрес: https://sandbox-secure.xsolla.com/paystation4/?token={token}. Внимание Для корректной работы метода требуется передать либо параметр user.country.value (код страны), либо заголовок X-User-Ip (IPv4-адрес пользователя, если страна неизвестна). Переданные данные используются для определения валюты оплаты в Xsolla. IPv6-адреса не поддерживаются. Выбранная валюта используется для оплаты в платежном интерфейсе Xsolla. ## Заказ Используйте методы из этого раздела для получения информации о заказах. ### Получение заказа - [GET /v2/project/{project_id}/order/{order_id}](https://xsolla.redocly.app/ru/api/catalog/order/get-order.md): Получает указанный заказ. ### Получение списка заказов за указанный период - [POST /v3/project/{project_id}/admin/order/search](https://xsolla.redocly.app/ru/api/catalog/order/admin-order-search.md): Возвращает список заказов, упорядоченный по дате создания — от самой ранней до самой поздней. ## Бесплатные товары Используйте методы из этого подраздела для начисления бесплатных товаров пользователям. ### Создание заказа с помощью бесплатной корзины - [POST /v2/project/{project_id}/free/cart](https://xsolla.redocly.app/ru/api/catalog/free-item/create-free-order.md): Создает заказ со всеми товарами из бесплатной корзины. Созданному заказу будет присвоен статус заказа done. ### Создание заказа с помощью определенной бесплатной корзины - [POST /v2/project/{project_id}/free/cart/{cart_id}](https://xsolla.redocly.app/ru/api/catalog/free-item/create-free-order-by-cart-id.md): Создает заказ со всеми товарами из определенной бесплатной корзины. Созданному заказу будет присвоен статус заказа done. ### Создание заказа с указанным бесплатным товаром - [POST /v2/project/{project_id}/free/item/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/free-item/create-free-order-with-item.md): Создает заказ с указанным бесплатным товаром. Созданному заказу будет присвоен статус заказа done. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ## Управление ### Обновление всех лимитов на покупку для пользователя - [DELETE /v2/project/{project_id}/admin/user/limit/item/all](https://xsolla.redocly.app/ru/api/catalog/user-limits-admin/reset-all-user-items-limit.md): Обновляет все лимиты на покупку для всех товаров для указанного пользователя, чтобы он мог приобрести эти товары снова. API лимитов на покупку позволяет вам продавать товар в ограниченном количестве. Чтобы настроить лимиты покупок, перейдите в раздел Admin нужного типа товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы ### Обновление лимита на покупку - [DELETE /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}/all](https://xsolla.redocly.app/ru/api/catalog/user-limits-admin/reset-user-item-limit.md): Обновляет лимит на покупку товара, чтобы пользователь мог купить его снова. Если параметр user равен null, этот метод обновляет лимит для всех пользователей. API лимитов на покупку позволяет вам продавать товар в ограниченном количестве. Чтобы настроить лимиты покупок, перейдите в раздел Admin нужного типа товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы ### Получение лимита доступных пользователю товаров - [GET /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/user-limits-admin/get-user-item-limit.md): Возвращает оставшееся количество товаров, доступных указанному пользователю, в пределах установленного лимита. API лимитов на покупку позволяет вам продавать товар в ограниченном количестве. Чтобы настроить лимиты покупок, перейдите в раздел Admin нужного типа товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы ### Увеличение лимита доступных пользователю товаров - [POST /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/user-limits-admin/add-user-item-limit.md): Увеличивает оставшееся количество товаров, доступных указанному пользователю, в пределах установленного ограничения. API лимитов на покупку позволяет вам продавать товар в ограниченном количестве. Чтобы настроить лимиты покупок, перейдите в раздел Admin нужного типа товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы ### Настройка лимита доступных пользователю товаров - [PUT /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/user-limits-admin/set-user-item-limit.md): Устанавливает количество товаров, которые указанный пользователь может купить в пределах ограничения, примененного после его увеличения или уменьшения. API лимитов на покупку позволяет вам продавать товар в ограниченном количестве. Чтобы настроить лимиты покупок, перейдите в раздел Admin нужного типа товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы ### Уменьшение лимита доступных пользователю товаров - [DELETE /v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/user-limits-admin/remove-user-item-limit.md): Уменьшает оставшееся количество товаров, доступных указанному пользователю в пределах установленного лимита. API лимитов на покупку позволяет вам продавать товар в ограниченном количестве. Чтобы настроить лимиты покупок, перейдите в раздел Admin нужного типа товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы ## Admin ### Импорт товаров из JSON-файла - [POST /v1/projects/{project_id}/import/from_external_file](https://xsolla.redocly.app/ru/api/catalog/connector-admin/import-items-from-external-file.md): Импортирует товары в магазин из JSON-файла по указанному URL-адресу. Подробная информация об импорте из JSON-файла приведена в документации. ### Получение статуса импорта товаров - [GET /v1/admin/projects/{project_id}/connectors/import_items/import/status](https://xsolla.redocly.app/ru/api/catalog/connector-admin/get-items-import-status.md): Возвращает информацию о прогрессе импорта товаров в проект. Метод возвращает данные по последнему импорту,  выполненному через API или Личный кабинет. ## Предзаказы ### Получение информации о лимите предзаказа товара - [GET /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/common-pre-orders/get-pre-order-limit.md): Возвращает ограничение на предзаказ товара. Pre-Order limit API позволяет продавать товар в ограниченном количестве. Для настройки самого предзаказа перейдите в раздел Admin желаемого товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы Алиасы для данного эндпоинта: * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id} ### Увеличение лимита предзаказа товара - [POST /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/common-pre-orders/add-pre-order-limit.md): Добавляет количество к ограничению на предзаказ товара. Pre-Order limit API позволяет продавать товар в ограниченном количестве. Для настройки самого предзаказа перейдите в раздел Admin желаемого товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы Алиасы для данного эндпоинта: * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id} ### Установка/обновление лимита предзаказа товара - [PUT /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/common-pre-orders/set-pre-order-limit.md): Устанавливает ограничение на количество товара для предварительного заказа. Pre-Order limit API позволяет продавать товар в ограниченном количестве. Для настройки самого предзаказа перейдите в раздел Admin желаемого товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы Алиасы для данного эндпоинта: * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id} ### Уменьшение лимита предзаказа товара - [DELETE /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}](https://xsolla.redocly.app/ru/api/catalog/common-pre-orders/remove-pre-order-limit.md): Удаляет ограничение на количество предзаказа товара. Pre-Order limit API позволяет продавать товар в ограниченном количестве. Для настройки самого предзаказа перейдите в раздел Admin желаемого товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы Алиасы для данного эндпоинта: * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id} ### Включение/отключение лимита предзаказа товара - [PUT /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/toggle](https://xsolla.redocly.app/ru/api/catalog/common-pre-orders/toggle-pre-order-limit.md): Включает/отключает лимит предзаказа товара. Pre-Order limit API позволяет вам продавать товар в ограниченном количестве. Для настройки самого предварительного заказа перейдите в раздел администратора модуля нужного товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы Алиасы для данного метода: * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}/toggle ### Обнуление лимита предзаказа товара - [DELETE /v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/all](https://xsolla.redocly.app/ru/api/catalog/common-pre-orders/remove-all-pre-order-limit.md): Удаляет все ограничения по количеству товара, предусмотренные для предварительного заказа. Pre-Order limit API позволяет вам продавать товар в ограниченном количестве. Для настройки самого предварительного заказа перейдите в раздел администратора модуля нужного товара: * Игровые ключи * Виртуальные предметы и валюта * Бандлы Aliases для этой конечной точки: * /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}/all ## Продавец ### Получение проектов - [GET /v2/merchant/{merchant_id}/projects](https://xsolla.redocly.app/ru/api/catalog/common-merchant/get-projects.md): Получает список проектов мерчанта. Внимание Этот метод API не включает в себя path-параметр project_id, поэтому для авторизации вам необходимо использовать ключ API, который действует во всех проектах. ## Catalog Данный API позволяет получать продаваемые товары любого вида или конкретный товар. ### Получение списка продаваемых товаров - [GET /v2/project/{project_id}/items](https://xsolla.redocly.app/ru/api/catalog/common-catalog/get-sellable-items.md): Получает список продаваемых товаров для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение продаваемого товара по ID - [GET /v2/project/{project_id}/items/id/{item_id}](https://xsolla.redocly.app/ru/api/catalog/common-catalog/get-sellable-item-by-id.md): Получает продаваемый товар по его ID. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение продаваемого товара по артикулу - [GET /v2/project/{project_id}/items/sku/{sku}](https://xsolla.redocly.app/ru/api/catalog/common-catalog/get-sellable-item-by-sku.md): Получает продаваемый товар по артикулу для построения каталога. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ### Получение списка продаваемых товаров по указанной группе - [GET /v2/project/{project_id}/items/group/{external_id}](https://xsolla.redocly.app/ru/api/catalog/common-catalog/get-sellable-items-group.md): Получает список продаваемых товаров из указанной группы для построения каталога. Внимание Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. Примечание Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода. ## Общие регионы Региональные ограничения продаж позволяют управлять доступностью товаров в отдельных странах или группах стран. Например, можно продавать игру только в определенных странах из-за лицензионных ограничений. Для настройки ограничений используются регионы. Каждый из них объединяет одну или несколько стран под одним идентификатором `region_id`. Товар может быть привязан к одному или нескольким регионам. Доступность товара определяется следующим образом: * Если у товара не указаны регионы — он доступен для покупки во всех странах. * Если у товара указаны регионы, и страна пользователя входит в один из них — товар доступен для этого пользователя. * Если у товара указаны регионы, и страна пользователя не входит ни в один из них — товар недоступен для этого пользователя. Страна пользователя передается в параметре `country` при запросе каталога через методы подраздела **Catalog**. Если параметр не передан, страна будет определена на основе IP-адреса пользователя. Соответствие страны пользователя региону товара проверяется дважды: при запросе каталога и при создании заказа. Недоступные товары не попадают в ответ каталога, а заказ с таким товаром не будет создан. Используйте методы группы **Общие регионы** для создания, изменения и удаления регионов. Сценарий настройки региональных ограничений продаж: 1. Создайте регион с помощью метода API [Создание региона](https://developers.xsolla.com/ru/api/catalog/common-regions/admin-create-region/), указав список стран. Метод возвращает `region_id`, который понадобится на следующем шаге. 2. Привяжите виртуальный товар к региону, передав его `region_id` в массиве `regions` при [создании](https://developers.xsolla.com/ru/api/catalog/virtual-items-currency-admin/admin-create-virtual-item/) или [обновлении](https://developers.xsolla.com/ru/api/catalog/virtual-items-currency-admin/admin-update-virtual-item/) товара. 3. Отобразите пользователю каталог, используя методы подраздела **Catalog**, например с помощью метода API [Получение списка виртуальных предметов](https://developers.xsolla.com/ru/api/catalog/virtual-items-currency-catalog/get-virtual-items). Страна пользователя определяется по параметру `country`, а если он не передан — по IP-адресу. Товары, недоступные в стране пользователя, не попадут в ответ каталога. 4. При переходе пользователя к оплате товара или корзины сформируйте заказ: * если товар был добавлен в корзину — с помощью метода API [Создание заказа со всеми товарами из определенной корзины](https://developers.xsolla.com/ru/api/catalog/payment-client-side/create-order) или [Создание заказа со всеми товарами из текущей корзины](https://developers.xsolla.com/ru/api/catalog/payment-client-side/create-order); * для быстрой покупки одного товара — с помощью метода API [Создание заказа с указанным товаром](https://developers.xsolla.com/ru/api/catalog/payment-client-side/create-order-with-item), передав артикул товара. В ответе вы получите токен для открытия платежного интерфейса.
Примечание

Xsolla проверяет, входит ли страна пользователя в регион, указанный у товара. Если страна не входит в регион товара, создание заказа будет недоступно.

5. Реализуйте открытие платежного интерфейса для оплаты заказа. ![Региональные ограничения](https://cdn.xsolla.net/developers/current/images/api_docs/api-regions.svg) ### Получение списка регионов - [GET /v2/project/{project_id}/admin/region](https://xsolla.redocly.app/ru/api/catalog/common-regions/admin-get-regions.md): Получает список регионов. Вы можете использовать регион для управления вашими региональными ограничениями. ### Создание региона - [POST /v2/project/{project_id}/admin/region](https://xsolla.redocly.app/ru/api/catalog/common-regions/admin-create-region.md): Создает регион. Вы можете использовать регион для управления вашими региональными ограничениями. ### Получение региона - [GET /v2/project/{project_id}/admin/region/{region_id}](https://xsolla.redocly.app/ru/api/catalog/common-regions/admin-get-region.md): Получает определенный регион. Вы можете использовать регион для управления вашими региональными ограничениями. ### Обновление региона - [PUT /v2/project/{project_id}/admin/region/{region_id}](https://xsolla.redocly.app/ru/api/catalog/common-regions/admin-update-region.md): Обновляет определенный регион. Вы можете использовать регион для управления вашими региональными ограничениями. ### Удаление региона - [DELETE /v2/project/{project_id}/admin/region/{region_id}](https://xsolla.redocly.app/ru/api/catalog/common-regions/admin-delete-region.md): Удаляет определенный регион. ## Вебхуки ### Обновление версии вебхука - [PUT /v2/project/{project_id}/admin/webhook/version](https://xsolla.redocly.app/ru/api/catalog/common-webhooks/update-webhook-version.md): Обновляет версию вебхуков в проекте. Для версии 2 в массиве items появляются дополнительные параметры. Подробная информация о настройке вебхуков доступна в разделе Отслеживание статуса заказа. ## Admin ### Получение списка атрибутов (admin) - [GET /v2/project/{project_id}/admin/attribute](https://xsolla.redocly.app/ru/api/catalog/attribute-admin/admin-get-attribute-list.md): Получает список атрибутов из проекта для администрирования. ### Создание атрибута - [POST /v2/project/{project_id}/admin/attribute](https://xsolla.redocly.app/ru/api/catalog/attribute-admin/admin-create-attribute.md): Создает атрибут. ### Обновление атрибута - [PUT /v2/project/{project_id}/admin/attribute/{external_id}](https://xsolla.redocly.app/ru/api/catalog/attribute-admin/admin-update-attribute.md): Обновляет атрибут. ### Получение указанного атрибута - [GET /v2/project/{project_id}/admin/attribute/{external_id}](https://xsolla.redocly.app/ru/api/catalog/attribute-admin/admin-get-attribute.md): Получает указанный атрибут. ### Удаление атрибута - [DELETE /v2/project/{project_id}/admin/attribute/{external_id}](https://xsolla.redocly.app/ru/api/catalog/attribute-admin/delete-attribute.md): Удаляет атрибут. ВниманиеЕсли вы удалите атрибут товара, все его данные и связи с товарами будут удалены. ### Создание значения атрибута - [POST /v2/project/{project_id}/admin/attribute/{external_id}/value](https://xsolla.redocly.app/ru/api/catalog/attribute-admin/admin-create-attribute-value.md): Создает значение атрибута. ВниманиеВсе проекты имеют ограничение на количество значений атрибута. Значение по умолчанию и максимальное значение — 20 значений для каждого атрибута. ### Удаление всех значений атрибута - [DELETE /v2/project/{project_id}/admin/attribute/{external_id}/value](https://xsolla.redocly.app/ru/api/catalog/attribute-admin/admin-delete-all-attribute-value.md): Удаляет все значения атрибута. ВниманиеЕсли вы удалите значение атрибута, связь атрибута с товарами будет потеряна. Чтобы изменить значение атрибута для товара, используйте метод Обновление значения атрибута вместо удаления значения и создания нового. ### Обновление значения атрибута - [PUT /v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}](https://xsolla.redocly.app/ru/api/catalog/attribute-admin/admin-update-attribute-value.md): Обновляет значения атрибута. ### Удаление значения атрибута - [DELETE /v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}](https://xsolla.redocly.app/ru/api/catalog/attribute-admin/admin-delete-attribute-value.md): Удаляет значение атрибута. ВниманиеЕсли вы удалите значение атрибута, связь атрибута с товарами будет потеряна. Чтобы изменить значение атрибута для товара, используйте метод Обновление значения атрибута вместо удаления значения и создания нового. ## Admin ### Получение списка групп товаров - [GET /v2/project/{project_id}/admin/items/groups](https://xsolla.redocly.app/ru/api/catalog/item-groups-admin/admin-get-item-group-list.md): Возвращает полный список групп товаров в рамках проекта без пагинации. Предназначен для административных задач. ПримечаниеНе используйте этот метод для построения каталога магазина. Вместо этого используйте клиентский метод Получение списка групп товаров. ### Создание группы товаров - [POST /v2/project/{project_id}/admin/items/groups](https://xsolla.redocly.app/ru/api/catalog/item-groups-admin/admin-create-item-group.md): Создает группу товаров в проекте. Чтобы получить группы товаров для построения каталога, используйте клиентский метод Получение списка групп товаров. ### Получение группы товаров по внешнему ID - [GET /v2/project/{project_id}/admin/items/groups/{external_id}](https://xsolla.redocly.app/ru/api/catalog/item-groups-admin/admin-get-item-group.md): Возвращает группу товаров по ее внешнему ID для администрирования. ПримечаниеНе используйте этот метод для построения каталога магазина. Вместо этого используйте клиентский метод Получение списка групп товаров. ### Обновление группы товаров - [PUT /v2/project/{project_id}/admin/items/groups/{external_id}](https://xsolla.redocly.app/ru/api/catalog/item-groups-admin/admin-update-item-group.md): Обновляет группу товаров по внешнему ID. ### Удаление группы товаров - [DELETE /v2/project/{project_id}/admin/items/groups/{external_id}](https://xsolla.redocly.app/ru/api/catalog/item-groups-admin/admin-delete-item-group.md): Удаляет группу товаров по внешнему ID. ### Получение списка групп по типу товаров - [GET /v2/project/{project_id}/admin/items/{item_type}/groups](https://xsolla.redocly.app/ru/api/catalog/item-groups-admin/admin-get-item-group-list-by-item-type.md): Возвращает список групп товаров с фильтрацией по типу товаров. Для групп подсчитывается только количество товаров, соответствующих заданному типу.Аналог метода Получение списка групп товаров endpoint, with additional filtering of items by type when counting them. ### Получение группы товаров по внешнему ID с фильтрацией по типу товара - [GET /v2/project/{project_id}/admin/items/{item_type}/groups/{external_id}](https://xsolla.redocly.app/ru/api/catalog/item-groups-admin/admin-get-item-group-by-item-type.md): Возвращает группу товаров по внешнему ID. Для группы подсчитывается только количество товаров, соответствующих заданному типу. Аналог метода Получение списка групп товаров по внешнему ID с дополнительной фильтрацией товаров по типу при подсчете их количества. ### Изменение порядка групп товаров - [PUT /v2/project/{project_id}/admin/group/order](https://xsolla.redocly.app/ru/api/catalog/item-groups-admin/admin-reorder-item-groups.md): Задает порядок отображения групп товаров в рамках проекта. Передайте массив групп с новыми значениями порядка. ### Изменение порядка товаров в группе (по внешнему ID группы) - [PUT /v2/project/{project_id}/admin/group/{external_id}/order/item](https://xsolla.redocly.app/ru/api/catalog/item-groups-admin/admin-reorder-items-in-group.md): Задает порядок отображения товаров в группе, определяемой ее внешним ID. Передайте массив товаров с новыми значениями порядка. ### Изменение порядка товаров в группе (по внутреннему ID группы) - [PUT /v2/project/{project_id}/admin/group/id/{id}/order/item](https://xsolla.redocly.app/ru/api/catalog/item-groups-admin/admin-reorder-items-in-group-by-id.md): Задает порядок отображения товаров в группе, определяемой ее внутренним числовым ID. Передайте массив товаров с новыми значениями порядка. ## Catalog ### Получение списка групп товаров - [GET /v2/project/{project_id}/items/groups](https://xsolla.redocly.app/ru/api/catalog/item-groups-catalog/get-item-groups.md): Возвращает список групп товаров для построения каталога без пагинации. NoteIn general, the use of catalog of items is available without authorization. Only authorized users can get a personalized catalog.