Авторизация по кнопке One Tap для Android

1. Добавьте репозиторий и пропишите значения в Manifest Placeholders.
2. Организуйте работу с подходящим для вас модулем VK ID SDK — Compose или XML. Дальнейшая работа с кнопкой определяется вашим подходом к работе с UI.

Работа с Compose

Укажите зависимости

dependencies {
    implementation("com.vk.id:onetap-compose:${sdkVersion — указывается последняя версия SDK, смотрите номер версии в начале страницы}")
}

Добавьте кнопку на экран

@Composable
fun ScreenWithVKIDButton() {
    OneTap(
        onAuth = { /*...*/ }
    )
}

Как настроить текст в кнопке One Tap

OneTap(
    ...
    scenario = OneTapTitleScenario.SignUp,
)

Включение отображения дополнительной кнопки «Войти в другой аккаунт»

OneTap(
    onAuth = { /*...*/ },
    signInAnotherAccountButtonEnabled = true
)

Стилизация кнопки

@Composable
fun ScreenWithVKIDButton() {
    OneTap(
        style = OneTapStyle.Light(
            cornersStyle = OneTapButtonCornersStyle.Custom(2f),
            sizeStyle = OneTapButtonSizeStyle.SMALL_32,
            elevationStyle = OneTapButtonElevationStyle.Custom(4f)
        )
    )
}

Отключение быстрой авторизации

OneTap(
        ...
        fastAuthEnabled = false,
    )

Как получить токен

@Composable
fun ScreenWithVKIDButton() {
    OneTap(onAuth = { oAuth, token ->
        // Использование токена.
    })
}

• если вы используете авторизацию через SDK с обменом кода на фронтенде, Access token привязывается к IP-адресу пользователя. Этот токен можно использовать только с того клиентского устройства, на котором прошла авторизация;
• если вы используете авторизацию через SDK с обменом кода на бэкенде, Access token привязывается к IP-адресу бэкенда сервиса. Токен можно использовать только на одном бэкенд-сервере — на том, который получил этот токен. Если передать токен на другой бэкенд-сервер или на фронтенд, возникнет ошибка.

@Composable
fun ScreenWithVKIDButton() {
    OneTap(onFail = { oAuth, fail ->
        when (fail) {
            is VKIDAuthFail.Canceled -> TODO()
            is VKIDAuthFail.FailedApiCall -> TODO()
            is VKIDAuthFail.FailedOAuthState -> TODO()
            is VKIDAuthFail.FailedRedirectActivity -> TODO()
            is VKIDAuthFail.NoBrowserAvailable -> TODO()
        }
    })
}

Работа с XML

• onAuthCode — при успешной аутентификации. В callback передается авторизационный код, который нужен для обмена на токены. Подробнее;
• onAuth — при успешной авторизации.
• onFail — при неуспешной авторизации.

Укажите зависимости

dependencies {
    implementation("com.vk.id:onetap-xml:${sdkVersion — указывается последняя версия SDK, смотрите номер версии в начале страницы}")
}

Добавьте кнопку на экран

<com.vk.id.onetap.xml.OneTap
    android:layout_width="300dp"
    android:layout_height="wrap_content"
    />

Как настроить текст в кнопке One Tap

findViewById<OneTap>(R.id.vkidButton).scenario = OneTapTitleScenario.SignUp

<com.vk.id.onetap.xml.OneTap
    ...
    app:vkid_onetapScenario="SignUp" />

Включение отображения дополнительной кнопки «Войти в другой аккаунт»

• С помощью атрибута vkid_onetapShowSignInToAnotherAccount:
  <com.vk.id.onetap.xml.OneTap
   ...
  app:vkid_onetapShowSignInToAnotherAccount="true" />

• С помощью property isSignInToAnotherAccountEnabled :
  findViewById<OneTap>(R.id.vkidButton).isSignInToAnotherAccountEnabled = true

Стилизация кнопки

fun onCreate(/* ... */) {
    findViewById<OneTap>(R.id.vkidButton).style = OneTapStyle.Light(
        cornersStyle = OneTapButtonCornersStyle.Custom(2f),
        sizeStyle = OneTapButtonSizeStyle.SMALL_32,
        elevationStyle = OneTapButtonElevationStyle.Custom(4f)
    )
}

<com.vk.id.onetap.xml.OneTap
    android:layout_width="355dp"
    android:layout_height="wrap_content"
    app:vkid_onetapStyle="secondaryDark"
    app:vkid_buttonsCornerRadius="8dp"
    app:vkid_buttonsSize="small32"
    app:vkid_onetapShowSignInToAnotherAccount="true" />

Отключение быстрой авторизации

• С помощью атрибута vkid_onetapFastAuthEnabled:
  <com.vk.id.onetap.xml.OneTap
          app:vkid_onetapFastAuthEnabled="false" />

• С помощью property fastAuthEnabled:
  findViewById<OneTap>(R.id.vkidButton).fastAuthEnabled = false

Как получить токен

fun onCreate(/* ... */) {
    findViewById<OneTap>(R.id.vkidButton).setCallbacks(
        onAuth = { oAuth, token -> /* Использование токена */ }
    )
}

• если вы используете авторизацию через SDK с обменом кода на фронтенде, Access token привязывается к IP-адресу пользователя. Этот токен можно использовать только с того клиентского устройства, на котором прошла авторизация;
• если вы используете авторизацию через SDK с обменом кода на бэкенде, Access token привязывается к IP-адресу бэкенда сервиса. Токен можно использовать только на одном бэкенд-сервере — на том, который получил этот токен. Если передать токен на другой бэкенд-сервер или на фронтенд, возникнет ошибка.

fun onCreate(/* ... */) {
    findViewById<OneTap>(R.id.vkidButton).setCallbacks(
        onFail = { oAuth, fail ->
            when (fail) {
                is VKIDAuthFail.Canceled -> TODO()
                is VKIDAuthFail.FailedApiCall -> TODO()
                is VKIDAuthFail.FailedOAuthState -> TODO()
                is VKIDAuthFail.FailedRedirectActivity -> TODO()
                is VKIDAuthFail.NoBrowserAvailable -> TODO()
            }
        }
    )
}

Как получить и обработать данные

OneTap(
    ...
    authParams = VKIDAuthUIParams {
        scopes = setOf("phone", "email")
    }
)

Подключение дополнительных способов входа в кнопке One Tap

1. Убедитесь, что в подразделе Авторизация приложения указаны нужные дополнительные способы входа в ваш сервис: Авторизация через Одноклассники, Авторизация через Mail.
2. Воспользуйтесь инструкцией ниже в зависимости от выбранного модуля VK ID SDK: Compose или XML.

1. Укажите список необходимых OAuth-провайдеров для их отображения:
   OneTap(
       ...
       oAuths = seOf(OneTapOAuth.Mail, OneTapOAuth.OK)
   )

2. После вы получите OAuth в callback, с помощью которого авторизовался пользователь:
   OneTap(
       ...
       onAuth = { oAuth, token -> when (oAuth) { ... } },
       onFail = { oAuth, fail -> when (oAuth) { ... } }
   )

1. Укажите список необходимых OAuth-провайдеров для их отображения. Вы можете сделать это в вёрстке с помощью атрибута vkid_onetapOAuths:
   <com.vk.id.onetap.xml.OneTap
       android:layout_width="300dp"
       android:layout_height="wrap_content"
       app:vkid_onetapOAuths="mail,ok"
       />

   Или программно с помощью property oAuths:
   findViewById<OneTap>(R.id.vkidButton).oAuths = setOf(OneTapOAuth.MAIL, OneTapOAuth.OK)

2. После вы получите OAuth в callback, с помощью которого авторизовался пользователь:
   findViewById<OneTap>(R.id.vkidButton).setCallbacks(
       onAuth = { oAuth, token -> when (oAuth) { ... } },
       onFail = { oAuth, fail -> when (oAuth) { ... } }
   )

Дальнейшие шаги

• При использовании схемы авторизации через SDK с обменом кода на бэкенде сгенерируйте параметры PKCE в приложении вашего сервиса согласно схеме и затем настройте авторизацию.
• Реализуйте получение информации о пользователе и другие необходимые методы.