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

Catalog API (2.0.0)

Введение

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

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

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

Методы API

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

  • Admin — методы для создания, обновления, удаления и настройки товаров и групп каталога. Для вызова требуется базовая HTTP-аутентификация с использованием учетных данных Личного кабинета. Не предназначены для построения витрин для конечных пользователей.
  • Catalog — методы для получения товаров и построения витрин для конечных пользователей. Поддерживают опциональную аутентификацию с использованием JWT пользователя для возврата персонализированных данных, таких как пользовательские лимиты и активные промоакции.

Аутентификация

Методы API требуют аутентификации либо от имени пользователя, либо от имени проекта. Тип используемой схемы аутентификации указан в блоке Безопасность в описании каждого метода.

Аутентификация с помощью JWT пользователя

Аутентификация с помощью JWT пользователя применяется, когда запрос выполняется из браузера, мобильного приложения или игры. По умолчанию используется XsollaLoginUserJWT. Подробная информация о создании токена приведена в документации Xsolla Login API.

Токен передается в заголовке Authorization в следующем формате: Authorization: Bearer <user_JWT>, где <user_JWT> — токен пользователя. Токен идентифицирует пользователя и обеспечивает доступ к персонализированным данным.

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

Базовая HTTP-аутентификация

Базовая HTTP-аутентификация применяется при взаимодействии server-to-server, когда вызов API отправляется напрямую с вашего сервера, а не из браузера пользователя или мобильного приложения. Обычно применяется базовая HTTP-аутентификация с использованием ключа API.

Примечание

Ключ API является конфиденциальным и не должен храниться или использоваться в клиентских приложениях.

При базовой серверной аутентификации все запросы к API должны содержать заголовок:

  • для basicAuth — Authorization: Basic <your_authorization_basic_key>, где your_authorization_basic_key — это пара project_id:api_key, закодированная по стандарту Base64;
  • для basicMerchantAuth — Authorization: Basic <your_authorization_basic_key>, где your_authorization_basic_key — это пара merchant_id:api_key, закодированная по стандарту Base64.

Значения параметров вы можете найти в Личном кабинете:

  • merchant_id отображается:
    • В разделе Настройки компании > Компания.
    • В адресной строке браузера на любой странице Личного кабинета. URL-адрес имеет вид: https://publisher.xsolla.com/<merchant_id>.
  • project_id отображается:
    • В Личном кабинете рядом с названием проекта.
    • В адресной строке браузера при работе с проектом в Личном кабинете. URL-адрес имеет вид: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.
  • api_key отображается в Личном кабинете только при создании и должен храниться на вашей стороне. Создать ключ можно в разделах:
Внимание

Если необходимый метод API не включает в себя path-параметр project_id, используйте для авторизации ключ API, который действует во всех проектах.

Подробная информация о работе с ключами API приведена в справочнике API.

Аутентификация с поддержкой гостевого доступа

Для продажи корзины используется схема аутентификации AuthForCart, которая поддерживает два режима:

  1. Аутентификация с помощью JWT пользователя. Токен передается в заголовке Authorization в следующем формате: Authorization: Bearer <user_JWT>, где <user_JWT> — токен пользователя. Токен идентифицирует пользователя и обеспечивает доступ к персонализированным данным. В качестве альтернативы вы можете использовать токен для открытия платежного интерфейса.

  2. Упрощенный режим без заголовка. Он применяется только для неавторизованных пользователей и может быть использована только для продажи игровых ключей. Вместо токена в запрос передаются заголовки:

    • x-unauthorized-id с ID запроса;
    • x-user с email пользователя, закодированным в формате Base64.

Базовая структура товара

Товары всех типов (виртуальные предметы, бандлы, виртуальная валюта, ключи) используют схожую структуру данных. Понимание базовой структуры упрощает работу с API и позволяет быстрее ориентироваться в документации.

Примечание

В некоторых методах могут использоваться дополнительные поля, но они не изменяют базовую структуру.

Идентификация

  • merchant_id — ID компании в Личном кабинете;
  • project_id — ID проекта в Личном кабинете;
  • sku — артикул товара, уникальный в рамках проекта.

Отображение в каталоге

  • name — название;
  • description — описание;
  • image_url — ссылка на изображение;
  • is_enabled — доступность товара;
  • is_show_in_store — отображение в каталоге.

Подробнее об управлении доступностью товаров в каталоге – в документации.

Организация

  • type — тип товара, например, виртуальный предмет (virtual_item) или бандл (bundle);
  • groups — группы, к которым относится товар;
  • order — порядок отображения в каталоге.

Условия продажи

  • prices — цены в реальной или виртуальной валюте;
  • limits — ограничения на покупку;
  • periods — период доступности;
  • regions — региональные ограничения.

Пример базовой структуры:

{
  "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": []
}

Настройка продажи товаров

Xsolla API позволяет реализовать логику магазина внутриигровых товаров,  включая получение каталога, управление корзиной, создание заказов и отслеживание их статусов. В зависимости от сценария интеграции методы API делятся на подразделы Admin и Catalog, которые используют разные схемы аутентификации.

Ниже приведен пример базового сценария настройки и работы магазина — от создания товаров до их продажи пользователю.

Создание товаров и групп (Admin)

Создайте каталог товаров для вашего магазина, например, виртуальные предметы, бандлы или виртуальную валюту.

Примеры методов:

Настройка акций, цепочек, ограничений (Admin)

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

Примеры методов:

Получение информации о товарах (Client)

Настройте отображение товаров магазина в вашем приложении.

Внимание

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

Примеры методов:

Примечание

По умолчанию в методах получения каталога возвращаются товары, которые отображаются в магазине на момент запроса. Чтобы получить информацию о товарах, период отображения которых еще не наступил или уже истек, передайте параметр "show_inactive_time_limited_items": 1 при запросе каталога.

Продажа товаров

Вы можете продавать товары за реальную валюту следующими способами:

  • Быстрая покупка — продажа одного товара, но в любом количестве.
  • Покупка корзины — пользователь наполняет корзину, добавляет и удаляет товары, изменяет количество в одном заказе.

Если товар оплачивается внутриигровой валютой, а не реальными деньгами, используйте метод Создание заказа с указанным товаром, приобретенным за виртуальную валюту. Платежный интерфейс открывать не нужно — списание происходит в момент вызова метода.

Если товар бесплатный, используйте метод Создание заказа с указанным бесплатным товаром или метод Создание заказа с помощью бесплатной корзины. Платежный интерфейс открывать не нужно — заказ сразу переходит в статус done.

Быстрая покупка

Используйте клиентский метод создания заказа с указанным товаром – в ответе вы получите токен, который используется для открытия платежного интерфейса.

Примечание

Информация о скидке доступна пользователю только в платежном интерфейсе. Использование промокодов не предусмотрено.

Покупка корзины

Наполнение и покупка корзины может осуществляться на клиенте или на сервере.

Наполнение и покупка корзины на клиенте

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

Реализуйте следующую логику работы с корзиной:

  1. После наполнения корзины игроком используйте метод Наполнение корзины товарами для наполнения корзины. В ответе вернется текущая информация о выбранных товарах — цены до и после применения скидок, бонусные товары.
  2. Обновите содержимое корзины в соответствии с действиями пользователя:
Примечание

Если вы хотите получить актуальное состояние корзины, используйте метод Получение корзины текущего пользователя.
  1. Используйте метод покупки корзины Создание заказа со всеми товарами из текущей корзины. В ответе вернутся ID заказа и платежный токен. Заказу будет присвоен статус new.

Наполнение и покупка корзины на сервере

Этот вариант наполнения корзины может занимать значительное время на настройку, поскольку каждое изменение корзины может сопровождаться вызовом большего количества методов API.

Реализуйте следующую логику работы с корзиной:

  1. После наполнения корзины игроком используйте методс Наполнение корзины товарамидля наполнения корзины. В ответе вернется текущая информация о выбранных товарах — цены до и после применения скидок, бонусные товары.
  2. Используйте метод покупки корзины Создание заказа со всеми товарами из текущей корзины. В ответе вернутся ID заказа и платежный токен. Заказу будет присвоен статус new.

Открытие платежного интерфейса

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

ДействиеЭндпоинт
Открыть в боевом окружении.https://secure.xsolla.com/paystation4/?token={token}
Открыть в тестовом окружении.https://sandbox-secure.xsolla.com/paystation4/?token={token}
Примечание

Используйте тестовый режим (sandbox-режим) при разработке и тестировании — при совершении тестовой покупки с реальных счетов не списываются деньги. Для тестирования вы можете использовать тестовые банковские карты.

После проведения первого реального платежа в силу вступает строгая политика платежей в тестовом окружении. Проведение платежа в нем будет доступно только для пользователей, которые указаны в Личном кабинете в разделе Настройки компании > Пользователи.

Покупка виртуальной валюты и виртуальных предметов за реальную валюту возможна после подписания лицензионного договора с Xsolla. Для этого в Личном кабинете перейдите в Договоры и налоги > Договоры, заполните договор и дождитесь подтверждения согласования. Согласование может занять до 3 рабочих дней.

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

Возможные статусы заказа: - new — заказ создан; - paid — оплата получена; - done — товар начислен; - canceled — заказ отменен; - expired — истек срок оплаты.

Отслеживайте статус одним из следующих способов:

Пагинация

Методы API для запроса большого количества записей (например, для построения каталога) возвращают данные постранично. Пагинация — это механизм ограничения количества элементов, возвращаемых в одном ответе API, с возможностью последовательного получения следующих страниц.

Для управления количеством возвращаемых элементов используйте следующие параметры:

  • limit — количество элементов на странице;
  • offset — номер элемента, с которого выполняется вывод на странице (нумерация ведется с 0);
  • has_more — есть ли следующая страница;
  • total_items_count — общее количество элементов.

Пример запроса:

GET /items?limit=20&offset=40

Пример ответа:

{
  "items": [...],
  "has_more": true,
  "total_items_count": 135
}

Рекомендуется выполнять последовательные запросы до тех пор, пока в ответе не вернется has_more = false.

Формат даты и времени

Дата и время передаются в формате ISO 8601.

Поддерживаются:

  • смещение относительно UTC;
  • значение null, когда нет ограничения времени отображения предмета;
  • в отдельных полях используется Unix timestamp (в секундах).

Формат: YYYY-MM-DDTHH:MM:SS±HH:MM

Пример: 2026-03-16T10:00:00+03:00

Локализация

Xsolla поддерживает локализацию пользовательских полей, таких как название и описание товаров. Локализованные значения передаются в виде объекта, в котором ключом является код языка. Полный список поддерживаемых языков приведен в документации.

Поддерживаемые поля

Локализация может быть задана для следующих параметров:

  • name
  • description
  • long_description

Формат локали

Ключ локали может быть указан в одном из следующих форматов:

  • двухбуквенный код языка: en, ru
  • формат язык–страна: en-US, ru-RU, de-DE

Примеры

Пример с двухбуквенным кодом языка:

{
  "name": {
    "en": "Starter Pack",
    "ru": "Стартовый набор"
  }
}

Пример с форматом язык–страна:

{
  "description": {
    "en-US": "Premium bundle",
    "de-DE": "Premium-Paket"
  }
}

Формат ответа при ошибке

При возникновении ошибки API возвращает HTTP-статус и тело ответа в формате JSON. Полный список ошибок в работе магазина приведен в документации.

Пример ответа:

{
  "errorCode": 1102,
  "errorMessage": "Validation error",
  "statusCode": 422,
  "transactionId": "c9e1a..."
}
  • errorCode — код ошибки.
  • errorMessage — краткое описание ошибки.
  • statusCode — HTTP статус ответа.
  • transactionId — ID запроса. Возвращается не во всех случаях.
  • errorMessageExtended — дополнительные данные об ошибке, например параметры запроса. Возвращаются не во всех случаях.

Пример расширенного ответа:

{
  "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, чтобы быстрее идентифицировать запросы при анализе ошибок.
Скачать описание OpenAPI
index.json
index.yaml
Языки
Серверы
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/ru/api/catalog/

Основная информация

С помощью виртуальных предметов и валюты вы можете построить внутриигровой магазин и настроить его отображение пользователям. Доступны следующие типы товаров:

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

Для организации товаров в каталоге используются группы. Они позволяют логически объединять товары и управлять их отображением.

Используйте методы подраздела Admin для создания, обновления и удаления товаров.

Используйте методы подраздела Catalog для получения списков товаров и их отображения пользователям.

Уведомление

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

Примечание

Метод Получение списка виртуальных предметов возвращает подробные данные о предметах, включая цены и атрибуты, и поддерживает пагинацию — используйте его для отображения страниц каталога в витрине магазина.

Метод Получение списка всех виртуальных предметов возвращает артикул, название и описание предмета, а также ID и название группы без пагинации — используйте его для поиска или индексирования на стороне клиента.

Для реализации покупок за виртуальную валюту используйте метод Создание заказа с указанным товаром, приобретенным за виртуальную валюту. Открывать платежный интерфейс не нужно — списание происходит в момент вызова метода.

Пример сценария покупки товара за виртуальную валюту:

Purchase flow with virtual currency example

Admin

Операции

Catalog

Операции

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

Операции

Основная информация

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

Для продажи игровых ключей аутентификация пользователей не требуется — ключи отправляются пользователю на указанный при покупке email-адрес. Настройка аутентификации обязательна, чтобы реализовать дополнительные сценарии: настроить персонализацию, ограничения на покупку или систему владения играми. Подробная информация доступна в разделе Как настроить аутентификацию для продажи игровых ключей.

Сценарий продажи игровых ключей:

  1. Создайте игру с помощью метода API Создание игры.
  2. Настройте региональные ограничения.
  3. Загрузите ключи в пакет игровых ключей с помощью метода API Загрузка кодов, чтобы продавать их пользователям.
  4. Отобразите пользователю каталог игр с ценами для его региона с помощью метода API Получение списка игр.
  5. Сформируйте заказ. Например, для быстрой покупки вы можете использовать метод API Создание заказа с указанным товаром, передав артикул игрового ключа. В ответе вы получите токен для открытия платежного интерфейса.
  6. Реализуйте открытие платежного интерфейса для оплаты заказа.

Настройте отслеживание статуса заказа, например с помощью вебхуков, чтобы своевременно получать данные об успешно оплаченных товарах и начислять их пользователю. Ключи отправляются пользователю на указанный при покупке email-адрес, после этого заказ переходит в статус done.

Игровые ключи

Catalog

Операции

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

Операции

Получение списка игр, принадлежащих пользователюClient-side

Запрос

Получает список игр, принадлежащих пользователю. Ответ будет содержать массив игр, принадлежащих определенному пользователю.

. Внимание

Все проекты имеют ограничение на количество товаров, которые вы можете получить в ответе. Значение по умолчанию и максимальное значение — 50 товаров на ответ.Чтобы получить больше данных постранично, используйте поля limit и offset.

Примечание

Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.
Безопасность
XsollaLoginUserJWT
Путь
project_idintegerобязательный

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта, а также в адресной строке браузера при работе с проектом. URL-адрес имеет следующий формат: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.

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

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

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

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

Пример: offset=0
sandboxinteger

Какой тип прав владения должен быть возвращен. Если параметру присвоено значение 1, возвращаются права владения, полученные пользователем только в режиме тестового окружения. Если параметр не передан или установлен в 0, возвращаются права владения, полученные пользователем только в режиме боевого окружения.

По умолчанию 0
additional_fields[]Array of strings

Список дополнительных полей. Эти поля будут в ответе, если вы отправите их в своем запросе. Доступные поля: attributes.

curl -i -X GET \
  'https://store.xsolla.com/api/v2/project/44056/entitlement?limit=50&offset=0&sandbox=0&additional_fields%5B%5D=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Ответы

Список игровых ключей, принадлежащих пользователю, успешно получен.

Телоapplication/json
has_moreboolean

Используется как индикатор того, что остались еще страницы.

total_items_countinteger

Общее количество игр, которыми владеет пользователь.

itemsArray of objects
items[].​namestring

Название игрового пакета.

items[].​descriptionstring

Описание игрового пакета.

items[].​project_idinteger

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

items[].​game_skustring[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$

Уникальный ID пакета ключей.

items[].​drmstring

Уникальный ID платформы.

Перечисление"steam""playstation""xbox""uplay""origin""drmfree""gog""epicgames""nintendo_eshop""discord_game_store"
items[].​image_urlstring

URL-адрес изображения. Для корректного отображения и быстрой загрузки изображения в платежном интерфейсе проверьте требования к файлу и ссылке:

  • Поддерживаемые форматы: WebP (рекомендуется), PNG, JPG.
  • Размер файла: ≤ 50 КБ (для WebP) или ≤ 150 КБ (для PNG и JPG).
  • Размер изображения: 280 x 280 px.
  • Цветовое пространство: sRGB.
  • Протокол передачи данных: HTTPS с долгосрочным кэшированием версионированных URL-адресов.

items[].​is_pre_orderboolean

Находится ли игра в статусе предзаказа.

Пример: false
items[].​attributesArray of objects

Список атрибутов и их значений, соответствующих игре.

Внимание. Эта часть ответа доступна только при отправке параметра запроса `additional_fields[]=attributes`.
items[].​attributes[].​external_idstring[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

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

items[].​attributes[].​namestring

Название атрибута.

Пример: "Genre"
items[].​attributes[].​valuesArray of objects
items[].​attributes[].​values[].​external_idstring[ 1 .. 255 ] characters^[-_.\d\w]+$

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

items[].​attributes[].​values[].​valuestring

Значение атрибута.

Пример: "Strategy"
Ответ
application/json
{
  "has_more": false,
  "total_items_count": 1,
  "items": [
    { … }
  ]
}

Активация игрового ключа на стороне клиентаClient-side

Запрос

Дает право владения по предоставленному игровому коду.

Notice

You can redeem codes only for the DRM-free platform.

Примечание

Без авторизации метод возвращает общие данные по каталогу товаров. Используйте авторизацию, чтобы получить персонализированные данные пользователя, такие как лимиты и акции, связанные с этим товаром. Для этого необходимо передать JWT пользователя в заголовке Authorization. Подробная информация о JWT пользователя приведена в блоке Безопасность для этого метода.
Безопасность
XsollaLoginUserJWT
Путь
project_idintegerобязательный

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта, а также в адресной строке браузера при работе с проектом. URL-адрес имеет следующий формат: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.

Пример: 44056
Телоapplication/jsonобязательный
codestringобязательный

Game code.

Пример: "AAAA-BBBB-CCCC-DDDD"
sandboxboolean

Redeem game code in the sandbox mode. The option is available for those users who are specified in the list of company users.

По умолчанию false
Пример: false
curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/entitlement/redeem \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "AAAA-BBBB-CCCC-DDDD",
    "sandbox": false
  }'

Ответы

Successful redemption.

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

Предоставление права владения (admin)Server-sideAdmin

Запрос

Дает пользователю право владения.

Внимание

Могут быть предоставлены только игровые ключи или игры для DRM-free-платформ.
Безопасность
basicAuth
Путь
project_idintegerобязательный

ID проекта. Вы можете найти этот параметр в Личном кабинете рядом с названием проекта, а также в адресной строке браузера при работе с проектом. URL-адрес имеет следующий формат: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.

Пример: 44056
Телоapplication/jsonобязательный
user_external_idstringобязательный

Unique user identifier.

Пример: "user-external-id"
gameobjectобязательный

Object with game properties.

Пример: {"sku":"com.xsolla.game_1"}
game.​skustring[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$обязательный

Уникальный ID пакета ключей.

Пример: "com.xsolla.game_1"
drmobjectобязательный

Object with DRM properties.

Пример: {"sku":"com.xsolla.key_1"}
drm.​skustringобязательный

Уникальный ID платформы.

Перечисление"steam""playstation""xbox""uplay""origin""drmfree""gog""epicgames""nintendo_eshop""discord_game_store"
Пример: "com.xsolla.key_1"
codestring or null

Game code of the game.

Пример: "AAAA-BBBB-CCCC-DDDD"
modestringобязательный

What type of entitlements should be granted. If the parameter is set to sandbox, the entitlement will be granted to the user in the sandbox mode. If the parameter is set to default, the entitlement will be granted to the user in the live mode.

Перечисление"default""sandbox"
Пример: "default"
user_countrystring or null

User's country.

Пример: "US"
curl -i -X POST \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/entitlement/grant \
  -H 'Content-Type: application/json' \
  -d '{
    "user_external_id": "user-external-id",
    "game": {
      "sku": "com.xsolla.game_1"
    },
    "drm": {
      "sku": "com.xsolla.key_1"
    },
    "code": "AAAA-BBBB-CCCC-DDDD",
    "mode": "default",
    "user_country": "US"
  }'

Ответы

Право владения предоставлено.

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

Admin

Операции

Основная информация

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

Используйте следующие группы методов API для работы с бандлами:

  • Admin — для создания, обновления, удаления бандлов и управления их видимостью.
  • Catalog — для получения списка бандлов.

Лимит на количество покупок настраивается с помощью объекта limits при создании или обновлении бандла. Подробная информация приведена в разделе Лимиты. Вы также можете настроить региональные ограничения, чтобы продавать товары в определенных странах.

Внимание

Подробная информация о настройке бандлов приведена в разделе Бандлы.

Сценарий работы с бандлами:

  1. Создайте бандл с помощью метода API Создание бандла. Чтобы проверить созданный бандл, используйте метод API Получение бандла. Чтобы получить список всех бандлов в проекте, используйте метод API Получение списка бандлов.
  2. При необходимости используйте метод API Обновление бандла для для изменения его состава или настроек.
  3. Реализуйте логику отображения бандлов в магазине с помощью методов API Получение списка бандлов, Получение указанного бандла или Получение списка бандлов по указанной группе.
  4. Сформируйте заказ, используя методы раздела Корзина и оплата. Например, для быстрой покупки вы можете использовать метод API Создание заказа с указанным товаром, передав артикул бандла. В ответе вы получите токен для открытия платежного интерфейса.
  5. Реализуйте открытие платежного интерфейса для оплаты заказа.
  6. Настройте отслеживание статуса заказа, например с помощью вебхуков, чтобы своевременно получать данные об успешно оплаченных товарах и начислять их пользователю.

Сценарий работы с бандлами:

Admin

Операции

Catalog

Операции

Основная информация

Корзина — это механизм покупки, который позволяет объединять несколько товаров в одном заказе. Пользователь может купить товары любого типа в любом количестве за реальную валюту, а также использовать промокоды.

Корзина хранится на стороне Xsolla. Сохранение корзины между сессиями зависит от того, авторизован ли пользователь:

  • Для авторизованных пользователей корзина привязана к конкретному пользователю и сохраняется между сессиями, пока запросы выполняются от имени того же пользователя.

    • Для неавторизованных пользователей сохранение корзины зависит от передачи заголовка x-unauthorized-id. Чтобы сохранить корзину неавторизованного пользователя между сессиями, передавайте один и тот же x-unauthorized-id в каждом запросе. Этот вариант доступен только при продаже игровых ключей.

Вы можете идентифицировать корзину двумя способами: автоматически по JWT пользователя или по ID корзины (cart_id).

Управление корзиной доступно как на стороне клиента, так и на стороне сервера.

На стороне сервера вы можете наполнить корзину товарами, например при восстановлении сессии пользователя. На стороне клиента доступны следующие действия:

  • получить корзину текущего пользователя или по ID корзины;
  • наполнить корзину;
  • обновить товары в корзине;
  • удалить товары из корзины.

Для оплаты товаров из корзины используются клиентские и серверные методы создания заказа.

По умолчанию время жизни корзины — 72 часа. Если состав корзины изменился, например при добавлении нового товара, ее время жизни продлевается.

После успешной оплаты корзина не очищается автоматически. Чтобы очистить корзину, используйте следующие клиентские методы API:

Сценарий использования корзины:

  1. Реализуйте интерфейс магазина, в котором пользователь будет выбирать товары.

  2. Когда пользователь выбирает товары в магазине, добавьте их в корзину, например с помощью метода Наполнение корзины товарами. В массиве items необходимо передать артикулы и количество необходимых товаров.

  3. Реализуйте интерфейс просмотра корзины. При переходе пользователя в корзину отобразите ее содержимое с помощью метода Получение корзины текущего пользователя. В ответе отобразится информация об итоговой цене товаров с учетом скидок, а также примененных акциях.

  4. Реализуйте открытие платежного интерфейса для оплаты заказа. Например, вы можете вызвать метод Создание заказа со всеми товарами из определенной корзины. В ответе вы получите токен для открытия платежного интерфейса.

  5. Настройте отслеживание статуса заказа, например с помощью вебхуков, чтобы своевременно получать данные об успешно оплаченных товарах и начислять их пользователю.

Примечание

Подробная информация о настройке продажи товаров в игре и онлайн приведена в руководстве по интеграции.

Сценарий использования корзины

Жизненный цикл заказа

Понимание жизненного цикла заказа поможет вам при настройке его отслеживания, например, чтобы начислить товары пользователю после успешной оплаты.

Заказ переходит по следующим статусам:

СтатусОписаниеПримечание
newЗаказ создан. Система ожидает подтверждение оплаты.Описания статусов транзакций приведены в документации Pay Station API.
paidЗаказ оплачен (транзакция перешла в статус done), и товар может быть начислен пользователю. Пока заказ не оплачен, он находится в статусе new.
doneТовар из заказа начислен пользователю. —
canceledПользователь оформил возврат платежа. Заказ переходит в этот статус, когда статус транзакции меняется на refunded.
expired Если новый заказ включает в себя товар, промокод или акцию, на которые настроены ограничения, предыдущий неоплаченный заказ с этим же товаром переходит в статус expired. Пользователь может оплатить только последний созданный заказ. Если пользователь пытается оплатить заказ, который находится в этом статусе, в платежном интерфейсе он увидит ошибку 2002 и не сможет совершить платеж.

Жизненный цикл заказа

Примечание

Если в процессе оплаты заказ перешел в статус expired, но пользователь успешно завершил платеж, заказ переходит из статуса expired в paid. Это возможно только если при оплате такого заказа не будет превышен лимит на покупку товара.

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

Используйте методы из этого подраздела для управления корзиной на стороне клиента.

Операции

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

Используйте методы из этого подраздела для управления корзиной на стороне сервера.

Операции

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

Используйте методы из этого подраздела для формирования платежного токена на стороне клиента.

Операции

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

Используйте методы из этого подраздела для формирования платежного токена на стороне сервера.

Операции

Заказ

Используйте методы из этого раздела для получения информации о заказах.

Операции

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

Используйте методы из этого подраздела для начисления бесплатных товаров пользователям.

Операции

Основная информация

Лимиты на покупку ограничивают количество товаров, доступных одному пользователю или всем пользователям. Вы также можете задавать периоды автоматического обновления лимитов.

Лимиты хранятся на стороне Xsolla и задаются на уровне конкретного товара в Личном кабинете или через объект limits в следующих методах API:

Информация о лимитах возвращается в объекте items.limits в методах получения каталога товаров:

Методы подраздела Управление из группы методов Лимиты позволяют получать информацию о текущем состоянии лимитов и изменять их для конкретного пользователя — например, сбрасывать счетчик после выполнения квеста или корректировать остаток вручную.

Примечание

Подробная информация по настройке лимитов в каталоге приведена в разделе Лимиты на покупку товаров.

Управление

Операции

Admin

Операции

Предзаказы

Операции

Продавец

Операции

Catalog

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

Операции

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

Операции

Admin

Операции

Admin

Операции

Catalog

Операции