Авторизация через единое веб окно

Обновлено 6 ноября 2024

Для корректной работы необходимо инициализировать SDK SDK до вызова методов авторизации

Описание сценария и метода loginWithIDToCustomTab

Для входа через единое веб окно Сбер ID используется метод

SID.Login.loginWithIDToCustomTab(context: Context, uri: Uri)

Описание параметров:

Context используется для запуска web интерфейса Uri для передачи всех данных, необходимых для аутентификации, таких как clientId, scope, state, nonce, redirectUri, customTabRedirectUri, codeChallenge и codeChallengeMethod.

Этот метод выполняет следующие действия:

Запускает веб интерфейс авторизации Сбер ID в CustomTabs. Метод проверяет, наличие установленных браузеров, которые поддерживают CustomTabs. Если на устройстве есть такой браузер, метод запускает CustomTabs, если нет WebVew.

Запуск сценария во внешнем браузере. Если по какой-то причине браузера с поддержкой CustomTabs на устройстве нет и WebView так же не получилось запустить, метод запустит сценарий во внешнем браузере, если такой есть.

Отображение Toast, о том что вход не доступен. Если ничего нет, отобразится Toast с текстом ошибки: "Не нашли браузер. Скачайте любой и повторите вход по Сбер ID."

Таким образом, этот метод обеспечивает гибкий способ входа, позволяя пользователю с большой вероятностью отобразить войти по Сбер ID через web интерфейс.

Если вы подключаете aar файлом зависимость (legacy):

Чтобы сценарий сработал, необходимо добавить зависимость на библиотеку браузера AndroidX в ваш проект. Для этого в файле build.gradle, в разделе зависимостей, добавьте следующую строку, если ее еще нет:

dependencies {
    implementation "androidx.browser:browser:1.3.0"
}

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

Формирование ссылки и запуск сценария

Обратите внимание, что clientID передается через настройки SDK

Для формирования uri используйте:

• Метод SID.Login.createUriForLogin позволяет создать uri для авторизации по Сбер ID.
• Передайте customTabRedirectUri deeplink на ваше приложение, позволяет подтвердить вход через мобильное приложение Сбербанк Онлайн.
• Класс PkceUtils содержит утилиты для создания значений параметров протокола PKCE (необязательные параметры, если вы не используете PKCE).

Обратите внимание, для работы данного сценария обязательно при создании URI передайте параметр customTabRedirectUri. Если вы не используете данный сценарий, вам достаточно передать пустой customTabRedirectUri = "". Данное ограничение связано с обратной совместимостью и техническими ограничениями, в будущем уйдем от данного костыля.

//Создание параметров для поддержки протокола PKCE.
val codeVerifier = PkceUtils.generateRandomCodeVerifier(SecureRandom())
val codeChallenge = PkceUtils.deriveCodeVerifierChallenge(codeVerifier)

//Создание Uri с параметрами для аутентификации, все значения нужно поменять на свои, тут указаны примеры
val uri = SID.Login.createUriForLogin(
            clientId = "clientId вашего сервиса", // на данный момент необходимо дублировать параметр
            scope = "добавьте все необходимые вам scope",
            state = "random_state",
            nonce = "random_nonce",
            redirectUri = "partner://redirect",
            customTabRedirectUri = "app://customtab_redirect/",// или пустое значение ""
            codeChallenge = codeChallenge,
            codeChallengeMethod = PkceUtils.getCodeChallengeMethod()
)

//Запуск аутентификации по Сбер ID, первым параметром нужно передать контекст
SID.Login.loginWithIDToCustomTab(context, uri)

Прочитать про общую схему входа, а так же параметры можно на страницу подключение Сбер ID

redirectUri и customTabRedirectUri должны быть добавлены для вашего сервиса в привязке к clientId. Для этого направьте запрос на support@ecom.sberbank.ru на добавление redirectUri и customTabRedirectUri в список доверенных. В запросе указывается clientId и список deeplink, по которым будет производиться возврат в мобильное приложение партнера. Сотрудник банка добавит домен в список разрешенных.

Если все сделано верно, вы увидите веб окно входа по Сбер ID. При этом мобильное приложение Сбербанк Онлайн не поднимется вне зависимости установлен он или нет.

Про обработку результата читайте в статье Обработка ответа после авторизации

Подтверждение входа через мобильное приложение Сбербанк Онлайн

Сейчас данная функция работает только для партнеров на ЕСА (единая система авторизации), legacy решение для Сбер ID. В будущем она будет поддержана и на новом решении. Если будут вопросы на почту support_sberid@sber.ru

Параметр customTabRedirectUri позволяет вернуться после подтверждения через мобильное приложении Сбербанк онлайн и продолжить работу в том же веб окне. Вам необходимо только зарегистрировать activity ReturnToCustomTabsSberIDActivity в AndroidManifest вашего приложения, которая открывается поверх окна с CustomTabs и сразу закрывается. Тем самым происходит возврат на то самое веб окно, с которого начиналась авторизация в вебе.

 <activity
            android:name="sberid.sdk.auth.view.activity.ReturnToCustomTabsSberIDActivity"
            android:screenOrientation="portrait"
            android:launchMode="singleTask">
            <intent-filter>
                <action android:name="android.intent.action.VIEW" />

                <category android:name="android.intent.category.DEFAULT" />
                <category android:name="android.intent.category.BROWSABLE" />

                <data
                    android:host="customtab_redirect"
                    android:scheme="app" />
            </intent-filter>
        </activity>

android:host и android:scheme соответствуют customTabRedirectUri из предыдущих шагов. redirectUri и customTabRedirectUri должны быть добавлены для вашего сервиса в привязке к clientId. Для этого направьте запрос на support@ecom.sberbank.ru на добавление redirectUri и customTabRedirectUri в список доверенных. В запросе указывается clientId и список deeplink, по которым будет производиться возврат в мобильное приложение партнера. Сотрудник банка добавит домен в список разрешенных.

Единое веб окно Сбер ID после восстановления продолжит свою работу и в результате, после авторизации пользователя, по redirectUri произойдет редирект на нужный экран вашего приложения. Про обработку результата читайте в статье Обработка ответа после авторизации

Передача номера на OIDC страницу

Вы можете при старте единого веб окна передать телефон пользователя, который пользователь ввел на ваших экранах входа. Это позволит сразу запустить подтверждение и ускорить вход. Для этого при формировании uri передайте параметр loginHint в формате

Название параметра	Обязательный	Описание	Формат	Пример
loginHint	нет	При передаче параметра номер телефона пользователя автоматически будет использован на странице входа по Сбер ID	должен соответствовать паттерну: ^(7)([349]\d{2}	8[0-7]\d{1})(\d{7})$

//Создание Uri с параметрами для аутентификации, все значения нужно поменять на свои, тут указаны примеры
val uri = SID.Login.createUriForLogin(
            clientId = "clientId вашего сервиса", // на данный момент необходимо дублировать параметр
            scope = "добавьте все необходимые вам scope",
            state = "random_state",
            nonce = "random_nonce",
            redirectUri = "partner://redirect",
            customTabRedirectUri = "app://customtab_redirect/",
            codeChallenge = codeChallenge,
            loginHint = "79ХХХХХХХХХ",
            codeChallengeMethod = PkceUtils.getCodeChallengeMethod()
)

Кастомизация окна авторизации

В SDK есть возможность кастомизации встроенного браузера, который появляется при входе через веб окно Сбер ID. Для этого необходимо передать через Settings.setUIPreferences параметр themeColor со значениями light и dark для светлой и темной темы соответственно.

   val themeColor = SIDColor(
            light = Color.parseColor("#68B1F8"),
            dark = Color.parseColor("#ff3b58")
       )

   val preferences = SIDPreferences(themeColor = themeColor)
   Settings.setUIPreferences(preferences)

}

SIDPreferences содержит гораздо больше настроек, они необходимы для работы ЕЛК и описаны в отдельных инструкциях. Статья на данном портале по ЕЛК готовится и скоро в ней мы распишем и этот метод.

Если вы поддерживаете лишь одну тему, перешлите два одинаковых цвета в параметры themeColorLight и themeColorDark