Протокол OAuth 2.0 использует короткоживущие токены с долговременной авторизацией (refresh-токены) вместо долгоживущих токенов. Refresh-токен позволяет длительное время использовать ваше приложение без необходимости повторного ввода имени пользователя и пароля. При этом исключается вероятность того, что данные авторизации пользователя будут скомпрометированы.

Протокол OAuth 2.0 используется для авторизации:

• через имя пользователя или email-адрес и пароль;
• через социальные сети.

При включении настройки регистрация и авторизация пользователя выполняются с помощью вызова методов API Register new user и JWT auth by username and password. В библиотеке Login для авторизации по протоколу OAuth 2.0 предусмотрены те же методы, что и для авторизации с использованием токена в формате JWT.

Для настройки авторизации по протоколу OAuth 2.0:

1. Настройте авторизацию по протоколу OAuth 2.0 для варианта Авторизации в Личном кабинете.
2. Инициализируйте библиотеку.

Настройка авторизации по протоколу OAuth 2.0 для варианта Авторизации в Личном кабинете

1. Перейдите к вашему проекту в Личном кабинете.
2. Выберите пункт Авторизация в боковом меню.
3. Нажмите Настроить в панели с вариантом авторизации.
4. Перейдите к блоку Безопасность и выберите раздел OAuth 2.0 аутентификация.
5. Нажмите Добавить OAuth 2.0.
6. Укажите URI переадресации OAuth 2.0 и нажмите Подключить.
7. Скопируйте и сохраните ID клиента.

Инициализация библиотеки

Для инициализации библиотеки добавьте следующую строку в ваш исходный код проекта Android, указав следующие параметры:

• login-project-id — ID варианта авторизации, который можно найти в разделе Настройки авторизации > ID варианта авторизации в Личном кабинете.
• oauth2-client-id — ID клиента, полученный при настройке авторизации по протоколу OAuth 2.0 в Личном кабинете.

val loginConfig = LoginConfig.OauthBuilder()
                .setProjectId("login-project-id")
                .setOauthClientId("oauth2-client-id")
                .build()

XLogin.init(applicationContext, loginConfig)

Для работы с refresh-токенами в библиотеке Login реализованы следующие методы:

• XLogin.refreshToken — обновляет токен.
• XLogin.getToken — возвращает текущий токен.
• XLogin.isTokenExpired — возвращает true если срок действия токена истек.

Вы можете интегрировать SDK с собственной системой авторизации. В этом случае необходимо реализовать идентификацию пользователя по custom ID (ID пользователя, сформированный на вашем сервере) для открытия внутриигрового магазина, проведения платежа и управления инвентарем.

Сценарий взаимодействия c серверами Иксоллы при использовании собственной системы авторизации:

1. Ваш клиент отправляет на ваш сервер запрос на аутентификацию.
2. Ваш сервер аутентифицирует пользователя и отправляет на сервер Иксоллы запрос на получение JSON Web Token (JWT) пользователя, передавая custom ID.
3. Сервер Иксоллы возвращает JWT пользователя.
4. Ваш сервер передает JWT пользователя клиенту.
5. Полученный JWT пользователя используется методами SDK вместо авторизационного токена для открытия внутриигрового магазина, проведения платежа и управления инвентарем.

Чтобы использовать собственную систему авторизации совместно с продуктами Иксоллы:

1. В Личном кабинете настройте серверный OAuth 2.0-клиент.
2. Реализуйте получение серверного JWT.
3. Реализуйте получение JWT пользователя.
4. Реализуйте логику работы с внутриигровым магазином, покупками и инвентарем с использованием JWT пользователя.

Настройка серверного OAuth 2.0-клиента

1. Откройте ваш проект в Личном кабинете и перейдите в раздел Авторизация.
2. Нажмите Настроить в панели нужного варианта авторизации.
3. На странице навигации перейдите к блоку Безопасность и выберите раздел OAuth 2.0 аутентификация.
4. Нажмите Добавить OAuth 2.0.
5. Укажите URI переадресации OAuth 2.0.
6. Установите флажок Серверная (соединение server-to-server).
7. Нажмите Подключить.
8. Скопируйте и сохраните ID клиента и секретный ключ.

Получение серверного JWT

В серверной части вашего приложения реализуйте метод для получения серверного JWT с использованием запроса Generate JWT. Запрос должен содержать следующие параметры:

• grant_type — тип JWT, передайте значение client_credentials;
• client_secret — секретный ключ OAuth 2.0-клиента, полученный при настройке серверного OAuth 2.0-клиента;
• client_id — идентификатор OAuth 2.0-клиента, полученный при настройке серверного OAuth 2.0-клиента.

Получение JWT пользователя

В серверной части вашего приложения реализуйте метод для получения JWT пользователя с использованием запроса Auth by custom ID. Запрос должен содержать заголовок X-Server-Authorization: <server_JWT>, где <server_JWT> — серверный JWT, полученный на предыдущем шаге.

Использование JWT пользователя

Передайте JWT пользователя в метод XStore.init и используйте методы SDK для открытия внутриигрового магазина, проведения платежа и управления инвентарем.

Реализуйте получение нового JWT пользователя после истечения его срока жизни. Рекомендуется получать новый токен в фоновом режиме, без повторного входа пользователя в приложение.

Нативная авторизация позволяет пользователям войти в ваше приложение с помощью аккаунта социальной сети, настроенного на мобильном устройстве.

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

В настоящее время для SDK реализована нативная авторизация через следующие социальные сети:

• Google
• Facebook
• WeChat
• QQ

Чтобы настроить нативную авторизацию:

1. Настройте приложение в личном кабинете разработчика социальной сети:
   1. Для авторизации через Facebook:
      1. Зарегистрируйтесь и создайте новое приложение.
      2. Настройте страницу приложения в личном кабинете разработчика Facebook.
   2. Для авторизации через Google настройте проект в Google API Console.
   3. Для авторизации через WeChat:
      1. Зарегистрируйтесь и создайте новое мобильное приложение.
      2. Отправьте приложение на проверку.
   4. Для авторизации через QQ:
      1. Зарегистрируйтесь и создайте новое мобильное приложение.
      2. Отправьте приложение на проверку.

2. Настройте авторизацию через социальные сети на стороне Иксоллы:
   1. Для Facebook и Google настройте социальные сети в Личном кабинете.
   2. Для WeChat и QQ обратитесь к аккаунт-менеджеру проекта.

3. Установите библиотеки для авторизации через социальную сеть. Для этого откройте файл build.gradle вашего приложения и в разделе зависимостей добавьте следующие строки, где <version_number> — необходимая версия библиотеки:
   • Для авторизации через Facebook:

implementation 'com.xsolla.android:login-facebook:<version_number>'

1. • Для авторизации через Google:

implementation 'com.xsolla.android:login-google:<version_number>'

1. • Для авторизации через WeChat:

implementation 'com.xsolla.android:login-wechat:<version_number>'

1. • Для авторизации через QQ:

implementation 'com.xsolla.android:login-qq:<version_number>'

4. Инициализируйте библиотеку Login с указанием следующих параметров:
   • facebook_id — Идентификатор приложения из личного кабинета разработчика Facebook;
   • google_id — Идентификатор клиента из Google API Console для веб-приложения;
   • wechat_id — AppID из личного кабинета разработчика WeChat;
   • qq_id — AppID из личного кабинета разработчика QQ.

Пример инициализации библиотеки при аутентификации через JWT:

val loginConfig = LoginConfig.JwtBuilder()
                .setProjectId("login-project-id")
                .setSocialConfig(XLogin.SocialConfig(
                     facebookAppId = "facebook_id",
                     googleServerId = "google_id",
                     wechatAppId = "wechat_id",
                     qqAppId = "qq_id"
                ))
                .build()

XLogin.init(applicationContext, loginConfig)

Пример инициализации библиотеки при аутентификации через OAuth 2.0:

val loginConfig = LoginConfig.OauthBuilder()
                .setProjectId("login-project-id")
                .setOauthClientId("oauth2-client-id")
                .setSocialConfig(XLogin.SocialConfig(
                     facebookAppId = "facebook_id",
                     googleServerId = "google_id",
                     wechatAppId = "wechat_id",
                     qqAppId = "qq_id"
                ))

                .build()

XLogin.init(applicationContext, loginConfig)

5. Для авторизации через WeChat доработайте код приложения:
   • Добавьте в пакет <your_package_name>.wxapi класс WXEntryActivity, где <your_package_name> — название пакета вашего приложения:

package <your_package_name>.wxapi

import android.app.Activity
import android.os.Bundle
import com.tencent.mm.opensdk.modelbase.BaseReq
import com.tencent.mm.opensdk.modelbase.BaseResp
import com.tencent.mm.opensdk.openapi.IWXAPI
import com.tencent.mm.opensdk.openapi.IWXAPIEventHandler
import com.tencent.mm.opensdk.openapi.WXAPIFactory
import com.xsolla.android.login.social.LoginSocial

class WXEntryActivity : Activity(), IWXAPIEventHandler {

    private lateinit var iwxapi: IWXAPI

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        iwxapi = WXAPIFactory.createWXAPI(this, LoginSocial.wechatAppId, false)
        iwxapi.handleIntent(intent, this)
        finish()
    }

    override fun onReq(req: BaseReq?) {
    }

    override fun onResp(resp: BaseResp) {
        LoginSocial.wechatResult = resp
    }
}

1. • Добавьте в файл AndroidManifest.xml следующий элемент:

<activity
            android:name=".wxapi.WXEntryActivity"
            android:exported="true">

Настройка страницы приложения в личном кабинете разработчика Facebook

1. Перейдите к настройкам приложения в личном кабинете разработчика Facebook.
2. Перейдите Настройки > Основное.
3. Нажмите Добавить платформу и выберите Android.
4. В поле Название пакета Google Play укажите имя пакета вашего Android-приложения.
5. В поле Название класса укажите полное имя класса Activity по умолчанию.
6. Сгенерируйте хеш-ключ и укажите его в поле Ключевые хеш-адреса.
7. Нажмите Сохранить изменения.

Для дальнейшей настройки нативной авторизации вам понадобятся Идентификатор приложения и Секрет приложения, которые можно найти в настройках приложения в разделе Настройки > Основное.

Настройка проекта в Google API Console

1. Перейдите в Google API Console.
2. Нажмите Создать проект.
3. Укажите Название проекта и Местоположение, нажмите Создать.
4. Перейдите в созданный проект и в боковом меню нажмите Окно запроса доступа OAuth.
5. Установите флажок Внешнее и нажмите Создать.
6. Укажите необходимые параметры и нажмите Сохранить.
7. В боковом меню выберите Учетные данные.
8. Создайте клиент OAuth 2.0 для вашего Android-приложения:

1. 1. Нажмите Создать учетные данные и выберите пункт Идентификатор проекта OAuth.
   2. В поле Тип приложения укажите Android.
   3. Укажите Имя.
   4. В поле Название пакета укажите имя пакета вашего Android-приложения.
   5. Сгенерируйте SHA-ключ.
   6. В поле Контрольная сумма сертификата SHA-1 укажите SHA-ключ, сгенерированный на предыдущем шаге.
   7. Нажмите Создать.
   8. Нажмите OK.

9. Создайте клиент OAuth 2.0 для веб-приложения:
   1. Нажмите Создать учетные данные и выберите пункт Идентификатор проекта OAuth.
   2. В поле Тип приложения укажите Веб-приложение.
   3. Укажите Имя.
   4. Нажмите Добавить URI в разделе Разрешенные URI перенаправления и укажите URI https://login.xsolla.com/api/social/oauth2/callback.
   5. Нажмите Создать.
   6. Нажмите OK.

Для дальнейшей настройки нативной авторизации вам понадобятся Идентификатор клиента и Секретный код клиента, которые можно найти в настройках идентификатора клиента для веб-приложения.

Настройка социальных сетей для варианта авторизации в Личном кабинете Иксоллы

1. Перейдите к вашему проекту в Личном кабинете.
2. Нажмите Авторизация в боковом меню и перейдите в раздел Варианты авторизации > ваш вариант авторизации > Социальные сети.
3. Для настройки авторизации через Facebook:

1. 1. Нажмите Редактировать в панели Facebook и измените статус на Отключен.
   2. В поле Application ID укажите Идентификатор приложения из личного кабинета разработчика Facebook.
   3. В поле Application Secret укажите Секрет приложения из личного кабинета разработчика Facebook.
   4. Нажмите Подключить.

6. Для настройки авторизации через Google:
   1. Нажмите Редактировать в панели Google и измените статус на Отключен.
   2. В поле Application ID укажите Идентификатор клиента из Google API Console для веб-приложения.
   3. В поле Application Secret укажите Секретный код клиента из Google API Console для веб-приложения.
   4. Нажмите Подключить.

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

При использовании Login Unity SDK инвалидация существующего токена и генерация нового выполняется при вызове методов API Auth by username and password и Auth via social network, если для параметра with_logout указано значение 1.

Для применения инвалидации токена в вашем проекте Android необходимо в методах XLogin.login, XLogin.startSocialAuth и XLogin.finishSocialAuth передавать параметр withLogout = true.

Авторизация по ID устройства позволяет пользователям начать работу с приложением на мобильном устройстве без ввода данных для регистрации. При первом входе в приложение по ID устройства новый аккаунт создается автоматически, при этом пользователю не требуется вводить имя пользователя, email-адрес или другие данные.

С помощью ID устройства вы можете реализовать авторизацию пользователя на одном или нескольких мобильных устройствах в фоновом режиме. Для этого пользователю потребуется привязать к уже существующему аккаунту ID устройства.

ID устройства генерируется платформой и доступно приложениям, установленным на мобильном устройстве. SDK получает значение ID с помощью API платформы и использует это значение для выполнения различных функций с помощью API Иксоллы. ID Android-устройства передается в константе android.provider.Settings.Secure.ANDROID_ID.

В SDK реализованы методы для выполнения перечисленных ниже функций.

Аутентификация

Обновление аккаунта

Управление устройствами