Интеграция с серверами Иксоллы

При этом типе интеграции на стороне Иксоллы выполняются следующие задачи:
  • хранение и управление каталогом товаров;
  • управление ценами;
  • хранение данных о региональных ценах;
  • управление региональными ограничениями;
  • управление правами пользователей;
  • управление инвентарем;
  • управление рекламными кампаниями;
  • аутентификация пользователей;
  • обработка транзакций.
Сервер Discord
Общайтесь с командой Иксоллы и разработчиками, использующими продукты Иксоллы.
Вам не нужно настраивать собственную серверную часть и базу данных для этих задач.

Сценарий интеграции

Для интеграции с серверами Иксоллы с помощью плагина Game Commerce:
  1. Установите плагин.
  2. Настройте проект в Личном кабинете.
  3. Настройте продукт Авторизация или реализуйте свою систему авторизации с использованием Pay Station access token.
  4. Настройте модуль Виртуальная валюта (опционально).
  5. Настройте модуль Виртуальные предметы.
  6. Настройте проект UE4.
После завершения интеграции вы можете протестировать процесс оплаты.
Note
Данное руководство включает в себя минимальный набор настроек для быстрого запуска. Если у вас возникли вопросы по подключению, обратитесь к аккаунт-менеджеру проекта.

Установка плагина

  1. Скачайте Epic Games Launcher.
  2. Создайте новый проект UE4.
  3. Загрузите плагин из Unreal Engine Marketplace или GitHub.

После установки плагина вы можете запустить демокарты из директории Content Browser > Xsolla Content > Maps. Демокарты показывают возможности плагина и представляют собой возможный вариант реализации логики приложения.

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

Значения по умолчанию для демокарт:

KeyValue
ID варианта авторизации026201e3-7e40-11ea-a85b-42010aa80004
ID проекта77640

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

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

Настройка проекта в Личном кабинете

  1. Зарегистрируйтесь в Личном кабинете.
  2. Настройте проект, созданный автоматически после регистрации в Личном кабинете:
    1. В разделе Проекты выберите ваш проект и перейдите в Настройки проекта.
    2. На вкладке Общие настройки добавьте:
      • изображение (опционально);
      • языки проекта (английский установлен по умолчанию);
      • название проекта на всех добавленных языках;
      • сайт игры (опционально);
      • описание проекта (опционально).
    3. Нажмите Сохранить.

В процессе интеграции вам понадобятся следующие параметры:

  • ID проекта, который можно найти в разделе Настройки проекта > ID проекта.

  • ID варианта авторизации, который можно найти в разделе Настройки авторизации > ID варианта авторизации. Для него используется формат UUID.

Настройка Авторизации

  1. Откройте ваш проект в Личном кабинете.
  2. Нажмите Подключить в панели Авторизация. Вы можете перейти к настройкам продукта Авторизация из любого раздела Личного кабинета, нажав в боковом меню Авторизация.

  1. Перейдите в раздел Варианты авторизации и нажмите Настроить Авторизацию.

  1. Укажите Название и нажмите Создать.

  1. Перейдите в Общие настройки > раздел URL и укажите Callback URL, на который пользователь будет перенаправлен после подтверждения электронной почты или сброса пароля.
  2. Выберите Хранилище Иксоллы в разделе Хранение данных пользователей.
  3. Настройте авторизацию по протоколу OAuth 2.0:

    1. Перейдите в раздел Авторизация.
    2. В панели OAuth 2.0 authentication нажмите Подключить.
    3. Укажите URI переадресации OAuth 2.0 и нажмите Подключить.
    4. Скопируйте и сохраните ID клиента.

Note
ОAuth 2.0 является рекомендуемым способом аутентификации и выбран в настройках SDK по умолчанию.

Настройка модуля Виртуальная валюта

  1. Откройте ваш проект в Личном кабинете.
  2. Нажмите Подключить в панели Магазин. Вы можете перейти к настройкам продукта Внутриигровой магазин из любого раздела Личного кабинета, нажав в боковом меню Магазин.

  1. Нажмите Подключить в панели Виртуальная валюта.

  1. Создайте виртуальную валюту:
    1. Нажмите Создать виртуальную валюту.

    1. Укажите следующую информацию:
      • артикул;
      • название валюты;
      • стоимость единицы виртуальной валюты;
      • валюта по умолчанию;
      • признак премиум-валюты (опционально);
      • изображение (опционально).
    2. Нажмите Создать валюту.

  1. Создайте пакеты виртуальной валюты (опционально):
    1. Перейдите в Пакеты.
    2. Нажмите Создать пакет.

    1. Укажите следующую информацию:
      • артикул;
      • название пакета;
      • краткое описание;
      • виртуальная валюта;
      • количество единиц валюты в пакете;
      • цена;
      • валюта по умолчанию;
      • изображение (опционально).

    1. Установите переключатель Показывать в магазине в положение Вкл.
    2. Нажмите Создать пакет.

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

Настройка модуля Виртуальные предметы

Note
Методы SDK поддерживают следующие типы предметов:
  • Расходуемый предмет — предмет, который можно начислить или купить множество раз. Исчезает из инвентаря в процессе игры. Примеры: гранаты и пули для атаки противников, аптечка.
  • Нерасходуемый предмет — предмет, который можно начислить или купить только один раз, не исчезает из инвентаря. Примеры: доступ к локации, статус, подписка.
  • Непродлеваемая подписка — нерасходуемый предмет, который имеет период доступности, не исчезает из инвентаря. Примеры: премиум-доступ, сезонный доступ. Подробная информация о непродлеваемых подписках приведена в документации по продукту Внутриигровой магазин.

  1. Откройте ваш проект в Личном кабинете.
  2. Нажмите Подключить в панели Магазин. Вы можете перейти к настройкам продукта Внутриигровой магазин из любого раздела Личного кабинета, нажав в боковом меню Магазин.

  1. Нажмите Подключить в панели Виртуальные предметы.

  1. Нажмите Создать группу.

  1. Укажите Код группы и Название группы.
  2. Установите переключатель Показывать группу в магазине в положение Вкл.
  3. Нажмите Создать группу.

  1. Создайте предметы:
    1. Для каждого предмета укажите следующую информацию:
      • одна или несколько групп, к которым принадлежит предмет;
      • артикул;
      • название и краткое описание;
      • цены в реальной и виртуальной валюте;
      • изображение (опционально).

    1. В поле Свойство предмета раздела Параметры выберите одно из следующих свойств в зависимости от типа предмета:
      • расходуемый;
      • нерасходуемый;
      • непродлеваемая подписка.
    2. Нажмите Создать предмет.

  1. Убедитесь, что статус группы Включен.

Настройка проекта UE4

  1. Откройте UE4-проект в Unreal Editor.
  2. Только для Blueprint-проектов:
    1. Скомпилируйте UE4-проект.
    2. Перейдите в Content Browser и добавьте New C++ Class с родительской нодой None.
  3. Перейдите в Settings > Plugins > Installed > Xsolla Store SDK, установите флажок Enabled и нажмите кнопку Restart Now, чтобы сохранить настройки и перезапустить Unreal Editor.

  1. Укажите параметры проекта:
    1. Перейдите в Settings > Project Settings > Plugins > Xsolla Login и укажите следующие параметры:

      1. В полях Login ID и Demo Login ID укажите ID варианта авторизации из Личного кабинета.
      2. В полях Project ID и Demo Project ID, укажите ID проекта из Личного кабинета.
      3. Установите флажок Use OAuth 2.0.
      4. В поле Client ID укажите ID клиента, полученный при настройке авторизации по протоколу OAuth 2.0 в Личном кабинете.

Note
Если вы используете собственную систему авторизации, поля Login ID и Demo Login ID заполнять не требуется.

    1. Перейдите в Settings > Project Settings > Plugins > Xsolla Store и укажите ID проекта в полях Project ID и Demo Project ID.

    1. Перейдите в Settings > Project Settings > Plugins > Xsolla Inventory и укажите ID проекта в полях Project ID и Demo Project ID.

В результате ваш проект в Личном кабинете будет подключен к демокартам.

  1. Перейдите в Content Browser > View Options и установите флажки Show Engine Content и Show Plugin Content.

  1. Перейдите в Content Browser > Xsolla Content > Maps и запустите демокарту Demo_Store вашей игры. Убедитесь, что авторизация и другие функции работают корректно.
  2. Разработайте интерфейс для системы входа, внутриигрового магазина и других страниц вашего приложения.

Note
Вы можете создать собственное решение, следуя инструкциям UMG для UI, или использовать демосцену как шаблон. Чтобы адаптировать интерфейс демосцены под свое приложение, воспользуйтесь конструктором интерфейса.

  1. Настройте обработку событий в соответствии с логикой вашего приложения с помощью методов SDK. Чтобы начать работать с основными функциями SDK, следуйте пошаговым сценариям.

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

Тестирование процесса оплаты

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

Для тестирования оплаты на реальных платежах:

  1. Убедитесь, что вы заключили договор с Иксоллой.
  2. В вашем проекте UE4 снимите флажок Sandbox в разделе Settings > Project Settings > Plugins > Xsolla Store.

Note
После проведения первого реального платежа в силу вступает строгая политика платежей в sandbox-режиме. Проведение платежа в sandbox-режиме будет доступно только для пользователей, которые указаны в Личном кабинете в разделе Настройки компании > Пользователи.
Была ли статья полезна?
Спасибо!
Что может сделать страницу еще лучше? Сообщение
Жаль, что так произошло
Расскажите, почему статья не была полезна. Сообщение
Спасибо за обратную связь!
Ваши мысли и идеи помогут нам улучшить ваш пользовательский опыт.
Оценить страницу
Оценить страницу
Что может сделать страницу еще лучше?

В другой раз

Спасибо за обратную связь!

Продолжить чтение

Последнее обновление: 1 сентября 2021

Нашли опечатку или ошибку в тексте? Выделите ее и нажмите Ctrl+Enter.

Сообщите о проблеме
Мы постоянно улучшаем качество нашей документации. Ваш отзыв поможет нам в этом.
Укажите email-адрес, чтобы мы могли связаться с вами
Спасибо за обратную связь!