SDK enterprise-уровня для Unity / Интеграция с серверами Xsolla

Интеграция с серверами Xsolla

При этом типе интеграции на стороне Иксоллы выполняются следующие задачи:

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

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

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

Для интеграции с серверами Иксоллы с помощью ассета Game Commerce:

  1. Установите ассет.
  2. Настройте проект в Личном кабинете.
  3. Настройте продукт Авторизация или реализуйте свою систему авторизации с использованием Pay Station access token.
  4. Настройте модуль Виртуальная валюта (опционально).
  5. Настройте модуль Виртуальные предметы.
  6. Настройте проект Unity.

После завершения интеграции вы можете протестировать процесс оплаты.

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

Установка ассета

Примечание
На CDN доступна только последняя версия SDK. Если вам требуется другая версия, вы можете скачать ее с GitHub.
  1. Скачайте Unity.
  2. Выберите персональную или профессиональную лицензию Unity в зависимости от ваших предпочтений.
  3. Создайте новый проект Unity.
  4. Скачайте ассет.
  5. Распакуйте архив.
  6. В главном меню редактора Unity перейдите Assets > Import Package > Custom Package и выберите ассет.
  7. Убедитесь, что для создания сборки игры используется компилятор Mono (только для standalone-сборок):
    1. В главном меню выберите пункт Edit > Project Settings.
    2. Перейдите в раздел Other Settings > Configuration.
    3. Убедитесь, что в поле Scripting Backend выбрано значение Mono.

После установки ассета вы можете запустить демосцену Xsollus из директории Assets > Xsolla > DemoCommon > Scene. Демосцена показывает возможности ассета и представляет собой возможный вариант реализации логики приложения.

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

Значения по умолчанию для демосцены Xsollus:

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

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

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

Чтобы использовать демосцену или ее части в своем приложении, добавьте ее в настройках сборки:

  1. Запустите сцену Xsollus из каталога Assets > Xsolla > DemoCommon > Scene.
  2. В главном меню выберите пункт File > Build settings и нажмите Add Open Scenes.

Создание проекта в Личном кабинете

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

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

Базовая настройка варианта авторизации

  1. Откройте ваш проект в Личном кабинете.
  2. Нажмите Подключить в панели Авторизация или выберите пункт Авторизация в боковом меню.
  3. Нажмите Создать вариант авторизации.
  1. Выберите Стандартный вариант авторизации и нажмите Создать и настроить. Подождите, пока ваш новый вариант авторизации не будет создан. Затем вы увидите страницу навигации по настройкам проекта.
  2. В блоке Способы авторизации на странице навигации выберите способ, который больше подходит вашей игре, и нажмите Настроить.
  1. Продукт Авторизация предлагает для ваших игр три варианта:
    • Классическая авторизация
      Пользователи входят в игру, указав логин и пароль. Кроме того, пользователи могут войти, используя свой аккаунт в одной из социальных сетей.
    • Авторизация без пароля
      Пользователи входят в игру с помощью одноразовых кодов или ссылок, отправленных на их email-адрес или номер телефона. Вход через социальные сети также поддерживается.
    • Авторизация через социальные сети
      Пользователи входят в игру только через социальные сети.
  1. В верхнем блоке настроек на странице навигации нажмите Настройки callback URL и задайте значения следующих параметров:
    • Callback URL — URL-адрес или путь в приложении, на который перенаправляются пользователи после их успешной аутентификации, подтверждения электронной почты или сброса пароля. Можно указать несколько допустимых URL-адресов.
    • Callback URL ошибки — URL-адрес или путь в приложении, на который перенаправляется пользователь в случае ошибки аутентификации. Если значение не указано, будет использоваться значение Callback URL.
  1. Нажмите Сохранить изменения.
  1. Настройте аутентификации через социальные сети (опционально):
    1. Нажмите название вашего варианта авторизации в цепочке навигации, чтобы вернуться на страницу навигации.
    2. Перейдите к блоку Настройки аутентификации и выберите раздел Авторизация через социальные сети.
    3. Подключите социальные сети, через которые пользователи смогут регистрироваться и входить в приложение. Это можно сделать одним из следующих способов:
      • Чтобы подключить нужную социальную сеть, нажмите значок ⚙ и выберите пункт Подключить.
      • Чтобы подключить сразу несколько социальных сетей, выберите нужные панели (рамки панелей станут зелеными). Затем в раскрывающемся меню Управление выберите пункт Подключить.
      • Чтобы подключить сразу все доступные социальные сети, нажмите Выбрать все. Затем в раскрывающемся меню Управление выберите пункт Подключить.
  1. Настройте аутентификацию по протоколу OAuth 2.0:
    1. Нажмите название вашего варианта авторизации в цепочке навигации, чтобы вернуться на страницу навигации.
    2. Перейдите к блоку Безопасность и выберите раздел OAuth 2.0 аутентификация.
    3. Нажмите Добавить OAuth 2.0.
    4. Укажите URI переадресации OAuth 2.0 и нажмите Подключить.
    5. Скопируйте и сохраните ID клиента.
  1. Измените хранилище для данных пользователей (опционально). По умолчанию данные пользователей хранятся и обрабатываются на стороне Иксоллы. Если вы хотите подключить PlayFab, Firebase или собственное хранилище следуйте инструкции Подключение хранилища для данных пользователей.

В процессе интеграции вам понадобятся:

  • ID варианта авторизации. Чтобы получить его, откройте ваш проект в Личном кабинете, перейдите в раздел Авторизация > Дашборд и нажмите скопировать ID рядом с названием варианта авторизации.

  • ID клиента OAuth 2.0, который можно найти в Личном кабинете в разделе Авторизация > ваш проект авторизации > Безопасность > OAuth 2.0 аутентификация.

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

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

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

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

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

  1. Откройте ваш проект Unity.
  2. В главном меню выберите пункт Window > Xsolla > Edit Settings.
  3. Укажите параметры проекта в панели Inspector:
    1. В поле Login ID укажите ID варианта авторизации из Личного кабинета.
Примечание
Если вы используете собственную систему авторизации, поле Login ID заполнять не требуется.
    1. В поле Project ID укажите ID проекта из Личного кабинета.
    2. Чтобы включить режим тестирования, установите флажок Enable sandbox?.
    3. В поле Authorization method выберите OAuth2.0.
    4. В поле OAuth2.0 client ID укажите ID клиента, полученный при настройке авторизации по протоколу OAuth 2.0 в Личном кабинете.

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

  1. Запустите демосцену Assets > Xsolla > DemoCommon > Scene > Xsollus и убедитесь, что авторизация и другие функции работают корректно.
  2. Разработайте интерфейс для системы входа, внутриигрового магазина и других страниц вашего приложения.
Примечание
Вы можете создать собственное решение, следуя инструкциям Unity, или использовать демосцену как шаблон. Чтобы адаптировать интерфейс демосцены под свое приложение, воспользуйтесь конструктором интерфейса.
  1. Настройте обработку событий в соответствии с логикой вашего приложения с помощью методов SDK. Чтобы начать работать с основными функциями SDK, следуйте пошаговым сценариям.

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

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

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

  1. Убедитесь, что вы заключили договор с Иксоллой.
  2. В вашем проекте Unity снимите флажок Enable sandbox? в панели Inspector.

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

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

Последнее обновление: 22 января 2024

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

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