Сценарий пользователя

1. Пользователь переходит в Web Shop с настроенной аутентификацией через ID пользователя.
2. Пользователь авторизуется в Web Shop одним из способов:
   • Пользователь вводит свой ID в блоке Быстрый вход и нажимает кнопку входа.
   • Пользователь нажимает кнопку покупки у выбранного товара или кнопку входа в верхней панели:
     1. Открывается модальное окно ввода ID пользователя или входа через социальную сеть.
     2. Пользователь вводит свой ID и нажимает Продолжить или выбирает одну из социальных сетей, нажав значок социальной сети, и проходит аутентификацию на странице социальной сети.

3. Выполняется проверка существования пользователя. Если пользователь с указанным ID или аккаунтом социальной сети существует в игре, пользователь будет авторизован в Web Shop. В противном случае пользователь получит сообщение об ошибке.

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

1. В вашем приложении реализуйте обработку вебхука для проверки существования пользователя.

При получении вебхука приложение должно выполнять следующие действия:

• Поиск пользователя по полученному в вебхуке ID пользователя.
• Отправка одного из кодов статуса в зависимости от результатов поиска пользователя:
  • 200 HTTP-код с ответом вебхука, если пользователь найден;
  • 404 HTTP-код, если пользователь с таким ID не зарегистрирован в игре.
• Отправка атрибутов пользователя для персонализации.

2. Откройте проект в Личном кабинете.
3. В боковом меню нажмите Site Builder.
4. Нажмите Открыть Site Builder.
5. В конструкторе вашего сайта перейдите в блок Настройки входа.

6. Выберите вариант ID пользователя.

7. В раскрывающемся списке выберите Новый вариант Авторизации.

8. Введите URL-адрес, на который вы хотите получать вебхуки.

9. Настройте авторизацию через социальные сети, которые используются для авторизации в вашем приложении (опционально):
   1. Откройте проект в Личном кабинете и перейдите в раздел Login.
   2. Нажмите Настроить в панели нужного варианта авторизации.
   3. На странице навигации перейдите к блоку Аутентификация и выберите раздел Авторизация через социальные сети.

1. 4. Чтобы подключить социальную сеть, в карточке социальной сети нажмите значок ⚙ справа от названия и выберите пункт Подключить.

Диплинк — это специальный URL, который ведет пользователя не просто на главную страницу приложения или сайта, а сразу на конкретный раздел, страницу или выполняет определенное действие.

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

Сценарий пользователя

В мобильном приложении

1. Неавторизованный пользователь в Web Shop нажимает кнопку входа или кнопку покупки. Открывается модальное окно ввода ID пользователя или входа через мобильную игру.

2. Пользователь нажимает кнопку входа через игру.
3. Пользователь автоматически перенаправляется в игру, а оттуда — в Web Shop как авторизованный пользователь.

В настольной версии

1. Неавторизованный пользователь в Web Shop нажимает кнопку входа или кнопку покупки. Открывается модальное окно ввода ID пользователя или входа в мобильную версию игры с помощью QR-кода.

2. Пользователь сканирует QR-код с помощью мобильного устройства.
3. На мобильном устройстве открывается Web Shop.
4. Пользователь автоматически перенаправляется в игру, а оттуда — в Web Shop как авторизованный пользователь.

Сценарий взаимодействия сервисов

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

На стороне игры

1. В настройках вашей игры зарегистрируйте URL-схему для открытия игры через диплинк:
   • в приложениях под Android — в файле AndroidManifest.xml;
   • в приложениях под iOS — в файле Info.plist.

После регистрации схемы, когда пользователь авторизуется в Web Shop через игру, по указанному адресу должна открываться игра.

Пример URL-схемы для регистрации игры:
gamename://authorize?operationPayload=<VALUE>, где:
• gamename — название вашей игры, которая должна открываться на мобильном устройстве для авторизации пользователя.
• authorize — действие, которое должно быть выполнено после открытия игры gamename. Используйте название действия, которое соответствует действиям в операционной системе вашего приложения.
• operationPayload=<VALUE> — дополнительный параметр с информацией для генерации токена при авторизации.

Примеры:

• Регистрация URL-схемы в приложениях под iOS
• Регистрация URL-схемы в приложениях под Android

Copy

Full screen

Small screen

• xml

<key>CFBundleURLTypes</key>
  <array>
    <dict>
      <key>CFBundleTypeRole</key>
      <string>Editor</string>
      <key>CFBundleURLSchemes</key>
      <array>
        <string>gamename</string>
      </array>
    </dict>
  </array>

Copy

Full screen

Small screen

• xml

<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:scheme="gamename" android:host="authorize" />
</intent-filter>

2. Реализуйте генерацию авторизационного токена в формате JWT, используя ID пользователя из игры.

Пример вызова метода API генерации токена пользователя с использованием библиотеки curl:

curl -X 'POST' \
'https://sb-user-id-service.xsolla.com/api/v1/user-id/token' \
-H 'accept: /' \
-H 'Content-Type: application/json' \
-d '{
 "loginId": "000001aa-001a-0ab0-00001-01a01a01a01a",
 "settings": {
   "projectId": 123456,
   "merchantId": 123456
 },
 "user": {
   "id": "123",
   "country": "US"
 }
 "operationPayload": "kosarb2NyrtIWaegJAH1f6P7XrBYPXYDya5coc_ZzcfiS_5o4QTUAL-CcGRC_Kv4CAtg"
}'

Вы получите ответ вида {token="JWT_TOKEN"}.

3. Добавьте всплывающее окно с уведомлением об успешной авторизации (опционально).
4. Реализуйте открытие Web Shop в браузере, используя полученный токен пользователя.

Пример URL-адреса для открытия Web Shop в браузере для авторизованного пользователя:
• https:​//example.com/?token={token}, если вы используете кастомный домен.
• https:​//example.xsolla.site/?token={token}, если вы используете домен Xsolla.

Где {token} — авторизационный токен пользователя.

На стороне Конструктора сайтов

1. В проекте в Личном кабинете перейдите в раздел Site Builder.
2. Нажмите Настроить в карточке вашего сайта Web Shop с аутентификацией через ID пользователя.
3. Перейдите к блоку Настройки аутентификации и выберите раздел ID пользователя.
4. Установите переключатель Авторизация по диплинку в активное положение.

5. В поле URL диплинка укажите ссылку для авторизации пользователя.

6. Если вы используете блок Быстрый вход на сайте:
   1. Перейдите к блоку Быстрый вход.
   2. В секции Настройки блока установите переключатель QR-код в активное положение.

7. Для проверки авторизации нажмите Просмотр.
8. Для публикации сайта нажмите Опубликовать.

Диплинк — это специальный URL, который ведет пользователя не просто на главную страницу приложения или сайта, а сразу на конкретный раздел, страницу или выполняет определенное действие.

Диплинки позволяют пользователю авторизоваться в Web Shop через игру в один клик, вместо того чтобы проходить процесс авторизации через ID пользователя или через Xsolla Login.

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

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

Сценарий пользователя

В мобильном приложении

1. Неавторизованный пользователь в Web Shop нажимает кнопку входа или кнопку покупки. Открывается модальное окно входа через мобильную игру.

2. Пользователь нажимает кнопку входа через игру.
3. Пользователь автоматически перенаправляется в игру, а оттуда — в Web Shop как авторизованный пользователь.

В настольной версии

1. Неавторизованный пользователь в Web Shop нажимает кнопку входа или кнопку покупки. Открывается модальное окно ввода ID пользователя или входа в мобильную версию игры с помощью QR-кода.

2. Пользователь сканирует QR-код с помощью мобильного устройства.
3. На мобильном устройстве открывается Web Shop.
4. Пользователь автоматически перенаправляется в игру, а оттуда — в Web Shop как авторизованный пользователь.

Сценарий взаимодействия сервисов

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

На стороне игры

1. В настройках вашей игры зарегистрируйте URL-схему для открытия игры через диплинк:
   • в приложениях под Android — в файле AndroidManifest.xml;
   • в приложениях под iOS — в файле Info.plist.

После регистрации схемы, когда пользователь авторизуется в Web Shop через игру, по указанному адресу должна открываться игра.

Пример URL-схемы для регистрации игры:
gamename://authorize?operationPayload=<VALUE>, где:
• gamename — название вашей игры, которая должна открываться на мобильном устройстве для авторизации пользователя.
• authorize — действие, которое должно быть выполнено после открытия игры gamename. Используйте название действия, которое соответствует действиям в операционной системе вашего приложения.
• operationPayload=<VALUE> — дополнительный параметр с информацией для генерации токена при авторизации.

Примеры:

• Регистрация URL-схемы в приложениях под iOS
• Регистрация URL-схемы в приложениях под Android

Copy

Full screen

Small screen

• xml

<key>CFBundleURLTypes</key>
  <array>
    <dict>
      <key>CFBundleTypeRole</key>
      <string>Editor</string>
      <key>CFBundleURLSchemes</key>
      <array>
        <string>gamename</string>
      </array>
    </dict>
  </array>

Copy

Full screen

Small screen

• xml

<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:scheme="gamename" android:host="authorize" />
</intent-filter>

2. Реализуйте генерацию авторизационного токена в формате JWT, используя ID пользователя из игры.

Xsolla API использует базовую аутентификацию. Все запросы к API должны содержать заголовок Authorization: Basic , где your_authorization_basic_key — пара client_id:client_secret, закодированная по стандарту Base64.

Настройка OAuth 2.0-клиента для серверной аутентификации выполняется через Личный кабинет. Подробные шаги описаны в инструкции.

Пример вызова метода API генерации токена пользователя с использованием библиотеки curl:

curl -X 'POST' \
'https://sb-user-id-service.xsolla.com/api/v1/user-id/token' \
-H 'Accept: /' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic <Base64Encoded(client_id:client_secret)>' \
-d '{
 "loginId": "000001aa-001a-0ab0-00001-01a01a01a01a",
 "settings": {
   "projectId": 123456,
   "merchantId": 123456
 },
 "user": {
   "id": "123",
   "country": "US"
 }
 "operationPayload": "kosarb2NyrtIWaegJAH1f6P7XrBYPXYDya5coc_ZzcfiS_5o4QTUAL-CcGRC_Kv4CAtg"
}'

Вы получите ответ вида {token="JWT_TOKEN"}.

3. Добавьте всплывающее окно с уведомлением об успешной авторизации (опционально).
4. Реализуйте открытие Web Shop в браузере, используя полученный токен пользователя.

Пример URL-адреса для открытия Web Shop в браузере для авторизованного пользователя:
• https:​//example.com/?token={token}, если вы используете кастомный домен.
• https:​//example.xsolla.site/?token={token}, если вы используете домен Xsolla.

Где {token} — авторизационный токен пользователя.

На стороне Конструктора сайтов

1. В проекте в Личном кабинете перейдите в раздел Site Builder.
2. Нажмите Настроить в карточке вашего сайта Web Shop.
3. Перейдите к блоку Настройки аутентификации и выберите раздел Deep link.

4. В поле URL диплинка укажите ссылку для авторизации пользователя.

5. Если вы используете блок Быстрый вход на сайте:
   1. Перейдите к блоку Быстрый вход.
   2. В секции Настройки блока можно настроить стиль отображения кнопки входа через QR-код.

6. Для проверки авторизации нажмите Просмотр.
7. Для публикации сайта нажмите Опубликовать.

Сценарий пользователя

1. Пользователь переходит в Web Shop с настроенной аутентификацией через Xsolla Login.
2. Пользователь нажимает кнопку покупки у выбранного товара, кнопку входа в верхней панели или кнопку входа в блоке Быстрый вход.
3. Открывается модальное окно со способами авторизации, настроенными в Xsolla Login.

4. Пользователь переходит к авторизации, при необходимости вводит дополнительные данные.
5. Выполняется проверка существования пользователя. Если пользователь существует в игре, он будет авторизован в Web Shop. В противном случае пользователь получит сообщение об ошибке.

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

1. В конструкторе вашего сайта перейдите в блок Настройки входа.

2. Выберите вариант авторизации Xsolla Login.
3. В раскрывающемся списке выберите Новый вариант Авторизации.

4. Перейдите к настройке созданного варианта авторизации из модального окна или нажмите Настройте способы авторизации в блоке Xsolla Login.

5. Подключите хранилище для данных пользователя.

В зависимости от способа хранения данных пользователей вам доступна разная функциональность продукта (см. раздел Сравнение хранилищ для данных пользователей).

Хранилище Xsolla

Если вы хотите, чтобы продукт Login выполнял всю логику аутентификации, используйте хранилище Xsolla. С этим типом хранилища вам будут доступны более гибкие настройки.

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

1. Перейдите к блоку База пользователей и выберите раздел Хранилище.
2. Выберите пункт Хранилище Xsolla и нажмите Сохранить изменения.

Хранилище PlayFab

Если вы хотите использовать функциональность PlayFab для работы с пользователями, подключите хранилище PlayFab. В хранилище записывается следующая информация:

• имя пользователя;
• email-адрес пользователя;
• пароль пользователя;
• поля с расширенной формы регистрации, если она настроена.

Хранилище PlayFab предоставляет вам доступ к следующим функциям:

• регистрация пользователей;
• аутентификация по email-адресу или имени пользователя и паролю;
• аутентификация через Twitch;
• сброс пароля пользователя;
• блокировка пользователя.

Чтобы подключить хранилище:

1. Перейдите к блоку База пользователей и выберите раздел Хранилище.
2. Выберите пункт PlayFab.
3. В поле Title ID введите значение того же поля из личного кабинета PlayFab.
4. Нажмите Сохранить изменения.

Хранилище Firebase

Если вы хотите использовать функциональность Firebase для работы с пользователями, подключите хранилище Firebase. В хранилище записывается следующая информация:

• имя пользователя;
• email-адрес пользователя;
• пароль пользователя;
• поля с расширенной формы регистрации, если она настроена.

1. Перейдите к блоку База пользователей и выберите раздел Хранилище.
2. Выберите пункт Firebase.
3. В поле Ключ API введите значение того же поля из личного кабинета Firebase.
4. Нажмите Сохранить изменения.

Собственное хранилище

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

Собственное хранилище предоставляет вам доступ к следующим функциям:

• регистрация пользователей;
• аутентификация пользователя с помощью email-адреса или имени пользователя и пароля;
• аутентификация без пароля по номеру телефона;
• аутентификация через социальные сети;
• сброс пароля пользователя.

1. Подключите собственное хранилище.
2. Настройте обработку запросов от сервера Xsolla Login.

Подключение собственного хранилища

1. Перейдите к блоку База пользователей и выберите раздел Хранилище.
2. Выберите пункт Собственное хранилище.
3. Введите URL-адреса для отправки запросов API:
   • URL для проверки существования пользователя;
   • URL для создания пользователя;
   • URL для изменения пароля;
   • URL для входа без пароля;
   • URL для входа через социальные сети.
4. Нажмите Сохранить изменения.
5. Для заданных вами URL-адресов реализуйте API, который будет отвечать следующим образом:
   • HTTP 200 / HTTP 204 для успешных запросов. Если требуется, JSON с дополнительными данными пользователя можно разместить в теле ответа. Переданные данные записываются в JWT (параметр partner_data).
   • Другие HTTP-коды для неуспешных запросов.

Настройка обработки запросов от сервера Xsolla Login

Запросы от сервера Xsolla Login отправляются на URL, указанные в Личном кабинете, с заголовком Authorization: Bearer <JWT>. JWT подписан секретным ключом проекта.

Чтобы обработать запрос:

1. Провалидируйте полученный JWT.
2. Если валидация прошла успешно, декодируйте JWT и убедитесь, что в его структуре есть поля из таблицы ниже. Для декодирования вы можете использовать библиотеку.

{
  "exp": 1573635020,
  "iat": 1573634600,
  "iss": "https://login.xsolla.com",
  "request_type": "gateway_request",
  "xsolla_login_project_id": "00000000-0000-0000-0000-000000000000"
}