# Shop Builder API # Overview * **Version:** 2.0.0 * **Servers**: `https://store.xsolla.com/api` * **[Contact Us by Email](mailto:integration@xsolla.com)** * **Contact URL:** https://xsolla.com/ * **Required TLS version:** 1.2 Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc. Version: 2.0.0 ## Servers ``` https://store.xsolla.com/api ``` ## Security ### XsollaLoginUserJWT По умолчанию для авторизации используется JWT пользователя Авторизации Иксолла (Bearer-токен). Вы можете попробовать вызвать этот метод с помощью тестового токена JWT пользователя Авторизации Иксолла: `Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`. В качестве альтернативы вы можете использовать [Pay Station access token](https://developers.xsolla.com/ru/api/pay-station/operation/create-token/). Type: http Scheme: bearer Bearer Format: JWT ### basicAuth Xsolla API использует базовую аутентификацию. Все запросы к API должны содержать заголовок `Authorization: Basic `, где `your_authorization_basic_key` — пара `project_id:api_key`, закодированная по стандарту Base64. Вы можете использовать `merchant_id` вместо, `project_id` при необходимости. Это не влияет на функциональность. Значения параметров вы можете найти в [Личном кабинете](https://publisher.xsolla.com/): * `merchant_id` отображается: * В разделе **Настройки компании > Компания** * В URL-адресе в адресной строке браузера на любой странице учетной записи издателя. URL-адрес имеет следующий формат: `https://publisher.xsolla.com/`. * `api_key` отображается в Личном кабинете только при создании и должен храниться на вашей стороне. Создать ключ можно в разделах: * **Настройки компании > Ключи API** * **Настройки проекта > Ключи API** * `project_id` отображается: * В Личном кабинете рядом с названием проекта. * В URL-адресе в адресной строке браузера при работе над проектом в учетной записи издателя. URL-адрес имеет следующий формат: `https://publisher.xsolla.com//projects/`. Подробная информация о работе с ключами API приведена в [справочнике API](https://developers.xsolla.com/ru/api/getting-started/#api_keys_overview). Type: http Scheme: basic ## Download OpenAPI description [Shop Builder API](https://developers.xsolla.com/_bundle/@l10n/ru/api/deprecated/inventory/index.yaml) ## Клиент ### Расходование предмета - [POST /v2/project/{project_id}/user/inventory/item/consume](https://developers.xsolla.com/ru/api/deprecated/inventory/inventory-client/consume-item.md): Метод клиента. Расходует предмет из инвентаря текущего пользователя. ### Получение инвентаря текущего пользователя - [GET /v2/project/{project_id}/user/inventory/items](https://developers.xsolla.com/ru/api/deprecated/inventory/inventory-client/get-user-inventory.md): Метод клиента. Получает инвентарь текущего пользователя. ВниманиеВсе проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ. Чтобы получить больше данных постранично, используйте поля limit и offset. ### Получение для текущего пользователя предметов с ограниченным сроком действия - [GET /v2/project/{project_id}/user/time_limited_items](https://developers.xsolla.com/ru/api/deprecated/inventory/inventory-client/get-user-subscriptions.md): Метод клиента. Получает для текущего пользователя предметы с ограниченным сроком действия. ### Получение виртуального баланса текущего пользователя - [GET /v2/project/{project_id}/user/virtual_currency_balance](https://developers.xsolla.com/ru/api/deprecated/inventory/inventory-client/get-user-virtual-balance.md): Метод клиента. Получает виртуальный баланс текущего пользователя. ## Управление ### Предоставление товаров пользователям ввиду покупки - [POST /v2/project/{project_id}/inventory/purchase](https://developers.xsolla.com/ru/api/deprecated/inventory/inventory-management/grant-item-by-purchase.md): Добавляет указанные товары в инвентари указанных пользователей ввиду покупки. ВниманиеОдновременно может быть обработано только 50 операций. Операции сверх данного ограничения будут игнорироваться. ### Изъятие товаров из инвентаря - [POST /v2/project/{project_id}/inventory/revoke](https://developers.xsolla.com/ru/api/deprecated/inventory/inventory-management/revoke-item.md): Отзывает права доступа к товарам для нескольких пользователей. ВниманиеОдновременно может быть обработано только 50 операций. Операции сверх данного ограничения будут игнорироваться. ### Предоставление товаров пользователям - [POST /v2/project/{project_id}/inventory/reward](https://developers.xsolla.com/ru/api/deprecated/inventory/inventory-management/add-item-to-inventory.md): Добавляет указанные товары в инвентари указанных пользователей. ВниманиеОдновременно может быть обработано только 50 операций. Операции сверх данного ограничения будут игнорироваться. ### Настройка товаров для пользователей - [POST /v2/project/{project_id}/inventory/set](https://developers.xsolla.com/ru/api/deprecated/inventory/inventory-management/set-item-quantity.md): Наполняет инвентари указанных пользователей указанными товарами. Обратите внимание, что новые данные заменят старые. ВниманиеОдновременно может быть обработано только 50 операций. Операции сверх данного ограничения будут игнорироваться. ## Кроссплатформенный инвентарь ### Подключение игрового аккаунта к Иксолле - [POST /v2/project/{project_id}/inventory/account/link](https://developers.xsolla.com/ru/api/deprecated/inventory/cross-inventory/inventory-account-link.md): Соединяет игровой аккаунт пользователя с аккаунтом Иксоллы. ### Токенизация пользователя - [POST /v2/project/{project_id}/inventory/account/signin](https://developers.xsolla.com/ru/api/deprecated/inventory/cross-inventory/inventory-account-signin.md): Получает JWT для работы с Shop Builder API для пользователей вашей платформы публикации.