Пользовательская кнопка VK ID для Android

Обратите внимание
Пользовательская кнопка должна соответствовать требованиям к дизайну.
Документация актуальна для версии VK ID SDK — 2.6.0.

Как инициализировать VK ID SDK

Перед дальнейшей работой убедитесь, что вы добавили репозиторий и прописали значения в Manifest Placeholders. Для инициализации SDK возьмите следующий код: build.gradle.kts

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

Чтобы запустить авторизацию в приложении для Android, настройте получение результата авторизации — реализуйте интерфейс VKIDAuthCallback. Пример реализации интерфейса VKIDAuthCallback в MainActivity

private val vkAuthCallback = object : VKIDAuthCallback {
    override fun onAuth(accessToken: AccessToken) {
        val token = accessToken.token
        //...
    }

    override fun onFail(fail: VKIDAuthFail) {
        when (fail) {
            is VKIDAuthFail.Canceled -> { /*...*/ }
            else -> {
                //...
            }
        }
    }
}

Как настроить proguard rules

После получения Access token его нужно передать в клиент, чтобы SDK заработал. Для хранения Access token на клиенте VK ID использует криптобиблиотеку. Чтобы компилятор не удалил ее в процессе оптимизации приложения, добавьте в proguard-rules.pro следующую строку:

-keep class com.google.crypto.tink.** { *; }

Если пропустить этот шаг, возможны падения приложения в процессе выполнения.

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

Чтобы получить токен, вызовите метод authorize() у объекта VKID. Во время запроса токена создаются фоновые потоки. Поэтому нужно передать LifecycleOwner — это обеспечит прекращение фоновой работы, когда ее результат больше не нужен. Пример кода в MainActivity

VKID.instance.authorize(this@MainActivity, vkAuthCallback) // Первый параметр LifecycleOwner, например activity.

Или можно запустить suspend-вариант метода authorize(): Пример кода в ViewModel

viewModelScope.launch {
    VKID.instance.authorize(vkAuthCallback)
}

После авторизации пользователя в сервисе с помощью VK ID в ответе приходит Access token с данными пользователя. Также после получения Access token происходит его привязка к IP-адресу:

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

Поле	Описание
token	Access token пользователя
idToken	ID token пользователя, нужен для получения публичных маскированных данных
userID	Идентификатор пользователя
expireTime	Время действия токена доступа в секундах
userData	Имя, фамилия, номер телефона, фото и почта
scopes	Список доступов, разрешенных пользователем для этого токена

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

Если приложению нужно получить данные пользователя, оно сможет воспользоваться методом vkid.getUserData(). Этот метод использует сохраненный AT и сделает запрос к /user_info. Подробнее Обратите внимание, что для доступа к телефону и почте нужно передать scopes "phone" и "email" соответственно. Это можно сделать через метод authorize(), передав в параметре params.scopes нужные доступы:

vkid.authorize(
    ...
    params = VKIDAuthParams {
        scopes = setOf("phone", "email")
    }
)

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

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