Подключение Unity-плагина

Требования к подключению

Версия Android: Android 7.0 (API Level 24) и выше.
Версия Unity: Unity 2022.3 и выше.

Шаг 1. Подготовьте идентификаторы

Перед началом интеграции получите идентификаторы, которые понадобятся при подключении SDK:

• Merchant ID — идентификатор магазина в личном кабинете Яндекс Пэй. Узнать Merchant ID
• Android package name (applicationId) — уникальный идентификатор Android-приложения. Подробнее об Application ID
• SHA256 Fingerprints — криптографический хэш сертификата Android-приложения. Получить SHA256 Fingerprints
• Client ID (YANDEX_CLIENT_ID) — идентификатор приложения в сервисе Яндекс OAuth. Получить Client ID

1.1 Получение SHA256 Fingerprints

Получите значение хеша SHA256 Fingerprints с помощью утилиты keytool:

keytool -list -v -alias <your-key-name> -keystore <path-to-production-keystore>

После ввода команды значение хеша отобразится в блоке Certificate fingerprints: SHA256.

1.2 Получение Client ID

Чтобы получить Client ID, зарегистрируйте приложение в сервисе Яндекс OAuth — это нужно, чтобы покупатели при оплате через Яндекс Пэй могли авторизоваться с помощью своего Яндекс ID.

1. Перейдите в сервис Яндекс OAuth, нажмите кнопку Создать, выберите вариант Для авторизации пользователей и перейдите к созданию.

   

2. В поле Название вашего сервиса укажите название, которое будет отображаться пользователям на экране авторизации, и загрузите иконку приложения.

   

3. В разделе Платформы приложений выберите Android-приложение и укажите его параметры:

   • Android package name — уникальное имя приложения из applicationId в конфигурационном файле проекта;
   • SHA256 Fingerprints — значение хеша SHA256. Все буквы в хеше должны быть заглавными.

   

4. Добавьте доступ к Яндекс Пэй: в разделе Права доступа к данным пользователей в поле Название доступа укажите и выберите Оплата через Yandex Pay.

   Примечание

   Доступ Управление заказами Yandex Pay Checkout не требуется. Если он у вас добавлен, удалите его.

   

5. Нажмите кнопку Продолжить → Всё верно, создать приложение и скопируйте значение поля Client ID.

   

6. В разделе Настройки личного кабинета Яндекс Пэй нажмите Добавить Client ID и укажите значение Client ID.

   

   Там же в разделе Настройки нажмите Добавить приложения, выберите нужный Client ID, платформу приложения и укажите SHA256 и Android package name в полях SHA256 Fingerprint и Android package name соответственно.

   

Шаг 2. Подключите плагин Yandex Pay InApps

{
  "dependencies": {
    "com.yandex.pay.inapps": "https://github.com/yandex-pay-mobile/inapps-unity-plugin.git"
  }
}

Шаг 3. Укажите Client ID

Укажите полученный Client ID в сборочном скрипте Assets/Plugins/Android/launcherTemplate.gradle в manifestPlaceholders в качестве значения YANDEX_CLIENT_ID:

android {
    defaultConfig {
        // Подставьте ваш Client ID
        manifestPlaceholders["YANDEX_CLIENT_ID"] = "12345678901234567890"
    }
}

Шаг 4. Добавьте Android Activity в манифест

Добавьте YPayActivity с указанной темой в манифест Assets/Plugins/Android/AndroidManifest.xml:

<manifest
    xmlns:android="http://schemas.android.com/apk/res/android">
    <application>
        ...
        <activity android:name="com.yandex.pay.inapps.YPayActivity"
            android:theme="@android:style/Theme.Translucent.NoTitleBar.Fullscreen" />
    </application>
</manifest>

Шаг 5. Разрешите Android-зависимости с помощью External Dependency Manager

В окне Unity-редактора выберите пункт меню: Assets → External Dependency Manager → Android → Force Resolve.

Интеграция Unity-плагина

Шаг 6. Разместите кнопку оплаты на сцене

1. Во вкладке Project Unity-редактора раскройте папку Packages.
2. В списке подключенных пакетов найдите Yandex Pay InApps.
3. Найдите шаблон кнопки в директории Yandex Pay InApps/Runtime/Prefabs/YPay Button и перетащите его на сцену.

Шаг 7. Укажите данные продавца

В инспекторе Unity выберите объект YPay Button. В редакторе кнопки заполните следующие данные:

• Merchant Id — Merchant ID магазина из личного кабинета Яндекс Пэй;
• Merchant Name — наименование продавца (магазина), которое будет отображаться у пользователя;
• Merchant Url — URL сайта продавца (магазина), который будет отображаться у пользователя.

Включите опцию Sandbox, если хотите использовать тестовое окружение.

Шаг 8. Сформируйте данные для оплаты

Разработайте класс, реализующий интерфейс IYPayDataProvider. Этот класс должен генерировать ключ платежной сессии и получать платежную ссылку из сервиса Яндекс Пэй.

using System.Threading.Tasks;
using UnityEngine;
using YPay;

public class YPayDataProvider : MonoBehaviour, IYPayDataProvider
{
    public string GetPaymentSessionKey()
    {
        // Генерация ключа платежной сессии
        var sessionKeyGenerator = new SomeSessionKeyGenerator();
        var sessionKey = sessionKeyGenerator.GenerateSessionKey();

        return sessionKey;
    }

    public async Task<string> GetPaymentUrlAsync()
    {
        // Получение платежной ссылки из Pay API
        var networkManager = new SomeNetworkManager();
        var paymentUrl = await networkManager.GetPaymentUrlAsync();

        return paymentUrl;
    }
}

Добавьте созданный скрипт в качестве компонента к кнопке оплаты.

Шаг 9. Обработайте результат оплаты

Разработайте класс, реализующий интерфейс IYPayResultListener.

using UnityEngine;
using YPay;

public class YPayResultListener : MonoBehaviour, IYPayResultListener
{
    public void OnPaymentResult(IYPayResult result)
    {
        // Обработка результата оплаты
        switch (result)
        {
            case IYPayResult.Success success:
                HandleSuccess(success.OrderId);
                break;
            case IYPayResult.Failure failure:
                HandleError(failure.ErrorMessage);
                break;
            case IYPayResult.Cancelled cancelled:
                HandleCancellation();
                break;
        }
    }
}

Добавьте созданный скрипт в качестве компонента к кнопке оплаты.

Шаг 10. Кастомизируйте кнопку оплаты

Кастомизируйте средствами Unity-редактора внешний вид кнопки оплаты в соответствии с вашими требованиями к дизайну.