Управление сбором информации о пользователях

Как это работает

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

• При использовании методов API:
  • имя пользователя;
  • email-адрес;
  • пароль.
• При использовании виджета авторизации:
  • email-адрес;
  • пароль.

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

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

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

1. Настройте ваш вариант авторизации в Личном кабинете.
2. Направьте запрос персональному менеджеру проекта на добавление в форму регистрации ваших собственных полей (необязательно).
3. Интегрируйте решение на стороне вашего приложения.

Настройка в Личном кабинете

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

4. Выберите, какую информацию о пользователях вы хотите собирать. Следующие поля и флажки могут быть отображены в форме регистрации пользователя:
   • Имя пользователя.
   • Имя.
   • Фамилия.
   • Дата рождения.
   • Страна.
   • Пол.
   • Новостная рассылка — флажок, с помощью которого пользователь может дать согласие на получение новостной рассылки. При установке пользователем флажка контакт пользователя автоматически экспортируется в Mailchimp, если Mailchimp подключен для вашего проекта.
   • Дополнительное соглашение — флажок, с помощью которого пользователь может подписать ваше дополнительное соглашение. Вы можете получить список пользователей, подписавших дополнительное соглашение, через Личный кабинет или через метод API. Список будет доступен в файле additional_agreement.csv.

5. Чтобы сделать ввод информации обязательным, нажмите значок ★ в строке с описанием соответствующего поля. Значок станет синим.

6. Нажмите Сохранить изменения.

Запрос на добавление собственных полей в форму регистрации

Помимо полей, доступных в Личном кабинете, вы можете добавить в форму регистрации собственные поля. Для этого обратитесь к персональному менеджеру проекта или напишите на csm@xsolla.com и передайте список полей с указанием следующей информации для каждого поля:

• название на английском языке;
• тип:
  • string;
  • date;
  • select — выбор одного варианта из списка;
  • multi-select — выбор нескольких вариантов из списка;
• является ли обязательным.

Для полей с типами select и multi-select также передайте персональному менеджеру проекта наборы возможных значений этих полей.

Интеграция на стороне приложения

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

При интеграции через Xsolla SDK сбор дополнительной информации о пользователях пока недоступен.

При интеграции через Login API в запросе Register new user передайте собранные дополнительные данные пользователя с помощью параметра fields. Данный параметр представляет собой набор пар свойство-значение. Полям формы регистрации, которые можно подключить в Личном кабинете, соответствуют следующие свойства параметра fields:

POST https://login.xsolla.com/api/user?login_url=https://example.com&projectId={projectId} HTTP/1.1
Content-Type: application/json

{
  "username": "john-email@email.com",
  "password": "123456",
  "email": "john-email@email.com",
  "fields": {
     "nickname": "John",
     "country-name": "US",
     "bday": "1997-07-16"
  }
}

curl --request POST \
  --url 'https://login.xsolla.com/api/user?login_url=https%3A%2F%2Fexample.com&projectId=projectId' \
  --header 'content-type: application/json' \
  --data '{"username":"john-email@email.com","password":"123456","email":"john-email@email.com","fields":{"nickname":"John","country-name":"US","bday":"1997-07-16"}}'

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

• Хранилище Xsolla
• Хранилище PlayFab
• Хранилище Firebase
• Собственное хранилище

Хранилище Xsolla

Хранилище PlayFab

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

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

1. Перейдите в раздел Players и нажмите ID пользователя.

2. Выберите вкладку Player Data (Title).

Хранилище Firebase

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

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

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

Пример:

В форму регистрации пользователей добавлены следующие поля:

• страна;
• собственное поле nickname типа string;
• собственное поле platform типа multi-select с возможными значениями: windows, mac os и linux.

При регистрации пользователя сервер Авторизации Иксоллы отправит на URL для создания пользователя запрос следующего вида:

POST https://your.hostname/new_user_url.path HTTP/1.1
Content-Type: application/json
Authorization: Bearer {JWT}

{
  "email": "john@gmail.com",
  "password": "123456",
  "country-name": "DE",
  "nickname": "JohnSnow",
  "platform": ["windows", "mac os"]
}

curl --request POST \
  --url 'https://your.hostname/new_user_url.path' \
  --header 'authorization: bearer_JWT' \
  --header 'content-type: application/json' \
  --data '{"email":"john@gmail.com","password":"123456","country-name":"DE","nickname":"JohnSnow","platform":["windows","mac os"]}'