Собственное хранилище данных пользователей
Если вы используете собственное хранилище данных пользователей, Xsolla Login выступает как посредник и все данные для идентификации пользователя хранятся на вашей стороне. Xsolla Login передает данные аутентификации в токене в заголовке и теле вебхуков.
Примечание
Email-адреса пользователей, данные социальных сетей и атрибуты пользователей хранятся на стороне Xsolla. Пароли не хранятся на стороне Xsolla.
- регистрация пользователей;
- аутентификация по имени пользователя и паролю;
- аутентификация без пароля по номеру телефона;
- аутентификация без пароля по email;
- аутентификация через социальные сети;
- cброс пароля пользователя.
Примечание
Если вы тестируете интеграцию локально, то
POST-запросы от Xsolla не доходят до URL-адресов вида http://localhost:3000/my-webhook-endpoint. Сервис ngrok позволяет создать туннель для внешнего доступа, благодаря чему вы сможете локально получать запросы от Xsolla. Подробнее вы можете прочитать в документации ngrok.Сценарий взаимодействия
Примечание
В качестве клиента может выступать виджет авторизации Xsolla или ваше приложение, которое использует методы Login API. Сценарий взаимодействия клиента и сервера Xsolla Login:
- Клиент отправляет запросы на сервер Xsolla Login. Формат запросов описан в группе методов Authentication methods.
- Сервер Xsolla Login отправляет вебхуки на ваш сервер. В заголовке передается серверный JWT, с параметром
“request_type”: “gateway_token”. Чтобы настроить валидацию токена в запросе, следуйте инструкции. Часть данных для идентификации пользователя передается в теле вебхука. - Чтобы подтвердить получение вебхука, ваш сервер должен вернуть:
200,201, или204HTTP-код в случае успешного ответа.400HTTP-код с описанием проблемы, если указанный пользователь не был найден или если передана недействительная подпись. Ваш обработчик вебхуков также может возвращать5xxHTTP-код при временных проблемах на вашем сервере.
- Сервер Xsolla Login обрабатывает ответ от вашего сервера и возвращает токен авторизации клиенту.
- Клиент обрабатывает ответ.
Если после идентификации пользователя вы хотите добавить информацию о пользователе в JWT, передайте в теле ответа JSON c любым набором параметров. Этот объект будет сохранен в поле JWT partner_data.
В качестве клиента может выступать виджет авторизации Xsolla или ваше приложение, которое использует методы Login API. Сценарий взаимодействия клиента и сервера Xsolla Login:
- Клиент отправляет запросы на сервер Xsolla Login. Формат запросов описан в группе методов Authentication methods.
- Сервер Xsolla Login отправляет вебхуки на ваш сервер. В заголовке передается серверный JWT, с параметром
“request_type”: “gateway_token”. Чтобы настроить валидацию токена в запросе, следуйте инструкции. Часть данных для идентификации пользователя передается в теле вебхука. - Чтобы подтвердить получение вебхука, ваш сервер должен вернуть:
200,201, или204HTTP-код в случае успешного ответа.400HTTP-код с описанием проблемы, если указанный пользователь не был найден или если передана недействительная подпись. Ваш обработчик вебхуков также может возвращать5xxHTTP-код при временных проблемах на вашем сервере.
- Сервер Xsolla Login обрабатывает ответ от вашего сервера и возвращает код авторизации клиенту.
- Клиент отправляет
POST-запрос Generate JWT на сервер Xsolla Login. Тело запроса должно содержать следующие обязательные параметры:grant_type— тип получения JWT, передайте значениеauthorization_code;client_id— ID клиента OAuth 2.0;client_secret— секретный ключ клиента OAuth 2.0. Обязателен для конфиденциального типа аутентификации.code— код авторизации.
- Сервер Xsolla Login отправляет клиенту пару JWT: access- и refresh-токен.
- Клиент обрабатывает ответ.
- Когда срок действия access-токена истекает, клиент отправляет
POST-запрос Generate JWT на сервер Xsolla Login. Тело запроса должно содержать следующие параметры:grant_type— тип получения JWT, передайте значениеrefresh_token;client_id— ID клиента OAuth 2.0;refresh_token— refresh-токен, полученный в ответ на запрос авторизации пользователя.
Если после идентификации пользователя вы хотите добавить информацию о пользователе в JWT, передайте в теле ответа JSON c любым набором параметров. Этот объект будет сохранен в поле JWT partner_data.
Примечание
Максимальная длина JSON c дополнительными данными о пользователе – 1000 символов.
- никнейм;
- дата рождения;
- имя;
- фамилия;
- ID пользователя на вашем сервере.
Вы также можете обновить атрибуты пользователя, для этого передайте массив объектов с атрибутами пользователя. Структура объектов описана ниже.
Структура объекта с атрибутом пользователя:
| Параметр | Тип | Описание |
|---|---|---|
attr_type | string | Тип атрибута, определяет уровень доступа пользователя к атрибутам сервиса:
|
key | string | Название атрибута, которое используется для идентификации атрибута пользователя. Должно быть уникальным для каждого пользователя. Максимальная длина: 256 символов. Вы можете использовать цифры, латинские буквы, подчеркивания и дефисы. |
permission | string or null | Тип доступа к атрибутам пользователя, влияет на список атрибутов, которые возвращают методы:
Возможные значения: public, private (по умолчанию). |
read_only | string | Защищен ли атрибут от изменений. По умолчанию false и изменять значения атрибута разрешено. |
value | string | Значение атрибута пользователя. Максимальная длина: 256 символов. |
Регистрация пользователя
Примечание
- Клиент отправляет
POST-запросRegister new user на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в Личном кабинете; - body-параметры:
username— имя пользователя, допустимая длина: от 3 до 255 символов;password— пароль, допустимая длина: от 6 до 100 символов;email— email-адрес, допустимая длина: от 1 до 255 символов.
- query-параметр
- Сервер Xsolla Login отправляет вебхук на URL для создания пользователя. Ответ на вебхук должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя.
- Клиент отправляет
POST-запросRegister new user на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в аккаунте для мобильных игр; - body-параметры:
username— имя пользователя, допустимая длина: от 3 до 255 символов;password— пароль, допустимая длина: от 6 до 100 символов;email— email-адрес, допустимая длина: от 1 до 255 символов.
- query-параметр
- Сервер Xsolla Login отправляет вебхук на URL для создания пользователя. Ответ на вебхук должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя.
- Клиент отправляет
Register new user POST-запрос на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в вашем аккаунте. - body-параметры:
username— имя пользователя. Допустимая длина: от 3 до 255 символов.password— пароль пользователя. Допустимая длина: от 6 до 100 символов.email— email-адрес пользователя. Допустимая длина: от 1 до 255 символов.
- query-параметр
- Сервер Xsolla Login отправляет вебхук на New user URL. Ответ должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя.
Примечание
Чтобы сопоставлять поля JSON и свойства профиля пользователя в Xsolla, а также настроить связывание аккаунтов по ID пользователя на вашем сервере, воспользуйтесь инструкцией.
Пример вебхука:
Copy
Full screen
Small screen
http
- http
- curl
1POST https://your.hostname/your_registration_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6 "email":"[email protected]",
7 "password":"123456",
8 "username":"[email protected]"
9}
1curl --request POST \
2 --url 'https://your.hostname/your_registration_uri' \
3 --header 'authorization: bearer_JWT' \
4 --header 'content-type: application/json' \
5 --data '{"email":"[email protected]","password":"123456","username":"[email protected]"}'
Пример ответа на вебхук с атрибутами пользователей:
Copy
Full screen
Small screen
- json
1{
2 "attributes": [
3 {
4 "attr_type": "server",
5 "key": "company",
6 "permission": "private",
7 "value": "facebook-promo"
8 },
9 {
10 "attr_type": "server",
11 "key": "custom-id",
12 "permission": "private",
13 "value": 48582
14 }
15 ]
16}
Пример ответа с объектом JSON:
Copy
Full screen
Small screen
- json
1{
2 "user": {
3 "player_id": "12345678",
4 "email": "[email protected]"
5 },
6 "user_info": {
7 "username": "gamer123",
8 "user_first_name": "John",
9 "user_last_name": "Doe",
10 "gender": "male",
11 "birthday": "1990-05-15",
12 "country": "US",
13 "language": "en"
14 },
15 "subscription_status": "active",
16 "loyalty_level": "gold"
17
18}
- Информация о пользователе записывается в базу данных Xsolla. При этом параметр
emailотмечается как неподтвержденный. - Письмо для подтверждения регистрации отправляется пользователю. Если вы интегрировали виджет авторизации, пользователь перенаправляется на страницу с сообщением: Письмо со ссылкой для подтверждения аккаунта отправлено на {email}.
- В случае неуспешной регистрации пользователя вы можете передать сообщение об ошибке, которое будет отображено в виджете авторизации. Для этого в ответе на запрос для создания пользователя передайте объект
error, в котором:- В параметре
codeукажите код ошибки, например011-002. - В параметре
descriptionукажите текст ошибки.
- В параметре
Пример объекта с сообщением об ошибке:
Copy
Full screen
Small screen
- json
1{
2 "error": {
3 "code": "011-002",
4 "description": "<string>"
5 }
6}
- Клиент отправляет
POST-запросRegister new user на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметры:
response_type— тип получения JWT, передайте значениеcode;client_id— ID клиента OAuth 2.0;state— значение, которое используется для дополнительной аутентификации пользователя. Необходимо для предотвращения атак CSRF. Значение возвращается в ответе, допустимая длина: от 1 до 8 символов.
- body-параметры:
username— имя пользователя, допустимая длина: от 3 до 255 символов;password— пароль, допустимая длина: от 6 до 100 символов;email— email-адрес, допустимая длина: от 1 до 255 символов.
- query-параметры:
- Сервер Xsolla Login отправляет вебхук на URL для создания пользователя. Ответ на вебхук должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя.
Примечание
Чтобы сопоставлять поля JSON и свойства профиля пользователя в Xsolla, а также настроить связывание аккаунтов по ID пользователя на вашем сервере, воспользуйтесь инструкцией.
Пример вебхука:
Copy
Full screen
Small screen
http
- http
- curl
1POST https://your.hostname/your_registration_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6 "email":"[email protected]",
7 "password":"123456",
8 "username":"[email protected]"
9}
1curl --request POST \
2 --url 'https://your.hostname/your_registration_uri' \
3 --header 'authorization: bearer_JWT' \
4 --header 'content-type: application/json' \
5 --data '{"email":"[email protected]","password":"123456","username":"[email protected]"}'
Пример ответа на вебхук с атрибутами пользователей:
Copy
Full screen
Small screen
- json
1{
2 "attributes": [
3 {
4 "attr_type": "server",
5 "key": "company",
6 "permission": "private",
7 "value": "facebook-promo"
8 },
9 {
10 "attr_type": "server",
11 "key": "custom-id",
12 "permission": "private",
13 "value": 48582
14 }
15 ]
16}
Пример ответа с объектом JSON:
Copy
Full screen
Small screen
- json
1{
2 "user": {
3 "player_id": "12345678",
4 "email": "[email protected]"
5 },
6 "user_info": {
7 "username": "gamer123",
8 "user_first_name": "John",
9 "user_last_name": "Doe",
10 "gender": "male",
11 "birthday": "1990-05-15",
12 "country": "US",
13 "language": "en"
14 },
15 "subscription_status": "active",
16 "loyalty_level": "gold"
17
18}
- Информация о пользователе записывается в базу данных Xsolla. При этом параметр
emailотмечается как неподтвержденный. - Письмо для подтверждения регистрации отправляется пользователю. Если вы интегрировали виджет авторизации, пользователь перенаправляется на страницу с сообщением: Письмо со ссылкой для подтверждения аккаунта отправлено на {email}.
- В случае неуспешной регистрации пользователя вы можете передать сообщение об ошибке, которое будет отображено в виджете авторизации. Для этого в ответе на запрос для создания пользователя передайте объект
error, в котором:- В параметре
codeукажите код ошибки, например011-002. - В параметре
descriptionукажите текст ошибки.
- В параметре
Пример объекта с сообщением об ошибке:
Copy
Full screen
Small screen
- json
1{
2 "error": {
3 "code": "011-002",
4 "description": "<string>"
5 }
6}
Аутентификация по имени пользователя и паролю
Примечание
- Клиент отправляет
POST-запросAuth by username and password на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в Личном кабинете; - body-параметры:
username— имя пользователя, допустимая длина: от 3 до 255 символов;password— пароль, допустимая длина: от 6 до 100 символов.
- query-параметр
- Сервер Xsolla Login отправляет вебхук на URL для проверки существования пользователя. Ответ на вебхук должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя.
- Клиент отправляет
POST-запросAuth by username and password на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в аккаунте для мобильных игр; - body-параметры:
username— имя пользователя, допустимая длина: от 3 до 255 символов;password— пароль, допустимая длина: от 6 до 100 символов.
- query-параметр
- Сервер Xsolla Login отправляет вебхук на URL для проверки существования пользователя. Ответ на вебхук должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя.
- Клиент отправляет
Auth by username and password POST-запрос на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в вашем аккаунте. - body-параметры:
username— имя пользователя. Допустимая длина: от 3 до 255 символов.password— пароль пользователя. Допустимая длина: от 6 до 100 символов.
- query-параметр
- Сервер Xsolla Login отправляет вебхук на User verification URL. Ответ должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя.
Примечание
Чтобы сопоставлять поля JSON и свойства профиля пользователя в Xsolla, а также настроить связывание аккаунтов по ID пользователя на вашем сервере, воспользуйтесь инструкцией.
Пример вебхука на URL для проверки существования пользователя:
Copy
Full screen
Small screen
http
- http
- curl
1POST https://your.hostname/your_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6 "email":"[email protected]",
7 "password":"123456",
8 "username":"[email protected]"
9}
1curl --request POST \
2 --url 'https://your.hostname/your_authentication_uri' \
3 --header 'authorization: bearer_JWT' \
4 --header 'content-type: application/json' \
5 --data '{"email":"[email protected]","password":"123456","username":"[email protected]"}'
Пример ответа на вебхук с атрибутами пользователей:
Copy
Full screen
Small screen
- json
1{
2 "attributes": [
3 {
4 "attr_type": "server",
5 "key": "company",
6 "permission": "private",
7 "value": "facebook-promo"
8 },
9 {
10 "attr_type": "server",
11 "key": "custom-id",
12 "permission": "private",
13 "value": 48582
14 }
15 ]
16}
Пример ответа с объектом JSON:
Copy
Full screen
Small screen
- json
1{
2 "user": {
3 "player_id": "12345678",
4 "email": "[email protected]"
5 },
6 "user_info": {
7 "username": "gamer123",
8 "user_first_name": "John",
9 "user_last_name": "Doe",
10 "gender": "male",
11 "birthday": "1990-05-15",
12 "country": "US",
13 "language": "en"
14 },
15 "subscription_status": "active",
16 "loyalty_level": "gold"
17
18}
- В случае неуспешной аутентификации пользователя вы можете передать сообщение об ошибке, которое будет отображено в виджете авторизации. Для этого в ответе на вебхук для создания пользователя передайте объект
error, в котором:- В параметре
codeукажите код ошибки, например011-002. - В параметре
descriptionукажите текст ошибки.
- В параметре
- Сервер Xsolla Login генерирует JWT пользователя.
- Пользователь перенаправляется на
login_urlс query-параметромtoken. В параметрtokenзаписывается JWT пользователя.
Примечание
Если в базе данных Xsolla нет записи о пользователе, создается новая.
- Клиент отправляет
POST-запросAuth by username and password на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметры:
response_type— тип получения JWT, передайте значениеcode;client_id— ID клиента OAuth 2.0;
state— значение, которое используется для дополнительной аутентификации пользователя. Необходимо для предотвращения атак CSRF. Значение возвращается в ответе, допустимая длина: от 1 до 8 символов.
- query-параметры:
- body-параметры:
username— имя пользователя, допустимая длина: от 3 до 255 символов;password— пароль, допустимая длина: от 6 до 100 символов.
- Сервер Xsolla Login отправляет вебхук на URL для проверки существования пользователя. Ответ на вебхук должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя.
Примечание
Чтобы сопоставлять поля JSON и свойства профиля пользователя в Xsolla, а также настроить связывание аккаунтов по ID пользователя на вашем сервере, воспользуйтесь инструкцией.
Пример вебхука на URL для проверки существования пользователя:
Copy
Full screen
Small screen
http
- http
- curl
1POST https://your.hostname/your_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6 "email":"[email protected]",
7 "password":"123456",
8 "username":"[email protected]"
9}
1curl --request POST \
2 --url 'https://your.hostname/your_authentication_uri' \
3 --header 'authorization: bearer_JWT' \
4 --header 'content-type: application/json' \
5 --data '{"email":"[email protected]","password":"123456","username":"[email protected]"}'
Пример ответа на вебхук с атрибутами пользователей:
Copy
Full screen
Small screen
- json
1{
2 "attributes": [
3 {
4 "attr_type": "server",
5 "key": "company",
6 "permission": "private",
7 "value": "facebook-promo"
8 },
9 {
10 "attr_type": "server",
11 "key": "custom-id",
12 "permission": "private",
13 "value": 48582
14 }
15 ]
16}
Пример ответа с объектом JSON:
Copy
Full screen
Small screen
- json
1{
2 "user": {
3 "player_id": "12345678",
4 "email": "[email protected]"
5 },
6 "user_info": {
7 "username": "gamer123",
8 "user_first_name": "John",
9 "user_last_name": "Doe",
10 "gender": "male",
11 "birthday": "1990-05-15",
12 "country": "US",
13 "language": "en"
14 },
15 "subscription_status": "active",
16 "loyalty_level": "gold"
17
18}
- В случае неуспешной аутентификации пользователя вы можете передать сообщение об ошибке, которое будет отображено в виджете авторизации. Для этого в ответе на вебхук для создания пользователя передайте объект
error, в котором:- В параметре
codeукажите код ошибки, например011-002. - В параметре
descriptionукажите текст ошибки.
- В параметре
- Сервер Xsolla Login генерирует JWT пользователя.
- Пользователь перенаправляется на
login_urlс query-параметромtoken. В параметрtokenзаписывается JWT пользователя.
Примечание
Если в базе данных Xsolla нет записи о пользователе, создается новая.
Аутентификация без пароля по номеру телефона
Примечание
- Клиент открывает форму аутентификации и предлагает пользователю ввести номер телефона.
- Пользователь вводит свой номер телефона.
- Клиент отправляет
POST-запросStart auth by phone number на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в Личном кабинете; - body-параметр
phone_number— номер телефона пользователя.
- query-параметр
- Клиент предлагает пользователю ввести код подтверждения.
- Пользователь вводит полученный код.
- Клиент отправляет
POST-запросComplete auth by phone number на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в Личном кабинете; - body-параметры:
code— код подтверждения;phone_number— номер телефона пользователя;operation_id— ID кода подтверждения.
- query-параметр
- Если это первая авторизация пользователя, сервер Xsolla Login отправляет вебхук на URL для входа без пароля. Ответ на вебхук должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя. - В случае неуспешной аутентификации пользователя вы можете передать сообщение об ошибке, которое будет отображено в виджете авторизации. Для этого в ответе на вебхук для создания пользователя передайте объект
error, в котором:- В параметре
codeукажите код ошибки, например011-002. - В параметре
descriptionукажите текст ошибки.
- В параметре
- Клиент открывает форму аутентификации и предлагает пользователю ввести номер телефона.
- Пользователь вводит свой номер телефона.
- Клиент отправляет
POST-запросStart auth by phone number на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в аккаунте для мобильных игр; - body-параметр
phone_number— номер телефона пользователя.
- query-параметр
- Клиент предлагает пользователю ввести код подтверждения.
- Пользователь вводит полученный код.
- Клиент отправляет
POST-запросComplete auth by phone number на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в аккаунте для мобильных игр; - body-параметры:
code— код подтверждения;phone_number— номер телефона пользователя;operation_id— ID кода подтверждения.
- query-параметр
- Если это первая авторизация пользователя, сервер Xsolla Login отправляет вебхук на URL для входа без пароля. Ответ на вебхук должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя. - В случае неуспешной аутентификации пользователя вы можете передать сообщение об ошибке, которое будет отображено в виджете авторизации. Для этого в ответе на вебхук для создания пользователя передайте объект
error, в котором:- В параметре
codeукажите код ошибки, например011-002. - В параметре
descriptionукажите текст ошибки.
- В параметре
- Клиент открывает форму аутентификации, чтобы пользователь мог ввести свой номер телефона.
- Пользователь вводит свой номер телефона.
- Клиент отправляет
Start auth by phone number POST-запрос на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в вашем аккаунте. - body-параметр
phone_number— номер телефона пользователя.
- query-параметр
- Клиент отображает поле, чтобы пользователь мог ввести код подтверждения.
- Пользователь вводит полученный код подтверждения.
- Клиент отправляет
Complete auth by phone number POST-запрос на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в вашем аккаунте. - body-параметры:
code— код подтверждения.phone_number— номер телефона пользователя.operation_id— ID кода подтверждения.
- query-параметр
- Если это первая авторизация пользователя, сервер Xsolla Login отправляет вебхук на Passwordless login URL. Ответ должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя. - В случае неуспешной аутентификации пользователя вы можете передать сообщение об ошибке, которое будет отображено в виджете авторизации. Для этого в ответе на запрос создания пользователя передайте объект
errorс следующими данными:- В параметре
codeукажите код ошибки, например011-002. - В параметре
descriptionукажите текст ошибки.
- В параметре
Примечание
Чтобы сопоставлять поля JSON и свойства профиля пользователя в Xsolla, а также настроить связывание аккаунтов по ID пользователя на вашем сервере, воспользуйтесь инструкцией.
Пример вебхука:
Copy
Full screen
Small screen
http
- http
- curl
1POST https://your.hostname/your_phone_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6 "login": "+12025550140",
7 "type": "phone"
8}
1curl --request POST \
2 --url 'https://your.hostname/your_phone_authentication_uri' \
3 --header 'authorization: bearer_JWT' \
4 --header 'content-type: application/json' \
5 --data '{"login":"+12025550140","type":"phone"}'
Пример ответа на вебхук с атрибутами пользователей:
Copy
Full screen
Small screen
- json
1{
2 "attributes": [
3 {
4 "attr_type": "server",
5 "key": "company",
6 "permission": "private",
7 "value": "facebook-promo"
8 },
9 {
10 "attr_type": "server",
11 "key": "custom-id",
12 "permission": "private",
13 "value": 48582
14 }
15 ]
16}
Пример ответа с объектом JSON:
Copy
Full screen
Small screen
- json
1{
2 "user": {
3 "player_id": "12345678",
4 "email": "[email protected]"
5 },
6 "user_info": {
7 "username": "gamer123",
8 "user_first_name": "John",
9 "user_last_name": "Doe",
10 "gender": "male",
11 "birthday": "1990-05-15",
12 "country": "US",
13 "language": "en"
14 },
15 "subscription_status": "active",
16 "loyalty_level": "gold"
17
18}
- Клиент открывает форму аутентификации и предлагает пользователю ввести номер телефона.
- Пользователь вводит свой номер телефона.
- Клиент отправляет
POST-запросStart auth by phone number на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметры:
response_type— тип получения JWT, передайте значениеcode;client_id— ID клиента OAuth 2.0;state— значение, которое используется для дополнительной аутентификации пользователя. Необходимо для предотвращения атак CSRF. Значение возвращается в ответе, допустимая длина: от 1 до 8 символов.
- body-параметр
phone_number— номер телефона пользователя.
- query-параметры:
- Клиент предлагает пользователю ввести код подтверждения.
- Пользователь вводит полученный код.
- Клиент отправляет
POST-запросComplete auth by phone number на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
client_id— ID клиента OAuth 2.0; - body-параметры:
code— код подтверждения;phone_number— номер телефона пользователя;operation_id— ID кода подтверждения.
- query-параметр
- Если это первая авторизация пользователя, сервер Xsolla Login отправляет вебхук на URL для входа без пароля. Ответ на вебхук должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя. - В случае неуспешной аутентификации пользователя вы можете передать сообщение об ошибке, которое будет отображено в виджете авторизации. Для этого в ответе на вебхук для создания пользователя передайте объект
error, в котором:- В параметре
codeукажите код ошибки, например011-002. - В параметре
descriptionукажите текст ошибки.
- В параметре
Примечание
Чтобы сопоставлять поля JSON и свойства профиля пользователя в Xsolla, а также настроить связывание аккаунтов по ID пользователя на вашем сервере, воспользуйтесь инструкцией.
Пример вебхука:
Copy
Full screen
Small screen
http
- http
- curl
1POST https://your.hostname/your_phone_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6 "login": "+12025550140",
7 "type": "phone"
8}
1curl --request POST \
2 --url 'https://your.hostname/your_phone_authentication_uri' \
3 --header 'authorization: bearer_JWT' \
4 --header 'content-type: application/json' \
5 --data '{"login":"+12025550140","type":"phone"}'
Пример ответа на вебхук с атрибутами пользователей:
Copy
Full screen
Small screen
- json
1{
2 "attributes": [
3 {
4 "attr_type": "server",
5 "key": "company",
6 "permission": "private",
7 "value": "facebook-promo"
8 },
9 {
10 "attr_type": "server",
11 "key": "custom-id",
12 "permission": "private",
13 "value": 48582
14 }
15 ]
16}
Пример ответа с объектом JSON:
Copy
Full screen
Small screen
- json
1{
2 "user": {
3 "player_id": "12345678",
4 "email": "[email protected]"
5 },
6 "user_info": {
7 "username": "gamer123",
8 "user_first_name": "John",
9 "user_last_name": "Doe",
10 "gender": "male",
11 "birthday": "1990-05-15",
12 "country": "US",
13 "language": "en"
14 },
15 "subscription_status": "active",
16 "loyalty_level": "gold"
17
18}
Аутентификация без пароля по email
Примечание
- Клиент открывает форму аутентификации и предлагает пользователю ввести email-адрес.
- Пользователь вводит свой email-адрес.
- Клиент отправляет
POST-запросStart auth by email на сервер Xsolla Login. - Запрос должен содержать следующие обязательные параметры:
- query-параметр
projectId— ID варианта авторизации в Личном кабинете; - body-параметр
email— email-адрес пользователя.
- query-параметр
- Клиент предлагает пользователю ввести код подтверждения.
- Пользователь вводит полученный код.
- Клиент отправляет
POST-запросComplete auth by email на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в Личном кабинете; - body-параметры:
code— код подтверждения;email— email-адрес пользователя;operation_id— ID кода подтверждения.
- query-параметр
- Если это первая авторизация пользователя, сервер Xsolla Login отправляет вебхук на URL для входа без пароля. Ответ на вебхук должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя. - В случае неуспешной аутентификации пользователя вы можете передать сообщение об ошибке, которое будет отображено в виджете авторизации. Для этого в ответе на вебхук для создания пользователя передайте объект
error, в котором:- В параметре
codeукажите код ошибки, например011-002. - В параметре
descriptionукажите текст ошибки.
- В параметре
- Клиент открывает форму аутентификации и предлагает пользователю ввести email-адрес.
- Пользователь вводит свой email-адрес.
- Клиент отправляет
POST-запросStart auth by email на сервер Xsolla Login. - Запрос должен содержать следующие обязательные параметры:
- query-параметр
projectId— ID варианта авторизации в аккаунте для мобильных игр; - body-параметр
email— email-адрес пользователя.
- query-параметр
- Клиент предлагает пользователю ввести код подтверждения.
- Пользователь вводит полученный код.
- Клиент отправляет
POST-запросComplete auth by email на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в аккаунте для мобильных игр; - body-параметры:
code— код подтверждения;email— email-адрес пользователя;operation_id— ID кода подтверждения.
- query-параметр
- Если это первая авторизация пользователя, сервер Xsolla Login отправляет вебхук на URL для входа без пароля. Ответ на вебхук должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя. - В случае неуспешной аутентификации пользователя вы можете передать сообщение об ошибке, которое будет отображено в виджете авторизации. Для этого в ответе на вебхук для создания пользователя передайте объект
error, в котором:- В параметре
codeукажите код ошибки, например011-002. - В параметре
descriptionукажите текст ошибки.
- В параметре
- Клиент открывает форму аутентификации, чтобы пользователь мог ввести свой email-адрес.
- Пользователь вводит свой email-адрес.
- Клиент отправляет
Start auth by email POST-запрос на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в вашем аккаунте. - body-параметр
email— email-адрес пользователя.
- query-параметр
- Клиент отображает поле, чтобы пользователь мог ввести код подтверждения.
- Пользователь вводит полученный код подтверждения.
- Клиент отправляет
Complete auth by email POST-запрос на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в вашем аккаунте. - body-параметры:
code— код подтверждения.email— email-адрес пользователя.operation_id— ID кода подтверждения.
- query-параметр
- Если это первая авторизация пользователя, сервер Xsolla Login отправляет вебхук на Passwordless login URL. Ответ должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя. - В случае неуспешной аутентификации пользователя вы можете передать сообщение об ошибке, которое будет отображено в виджете авторизации. Для этого в ответе на запрос создания пользователя передайте объект
errorс следующими данными:- В параметре
codeукажите код ошибки, например011-002. - В параметре
descriptionукажите текст ошибки.
- В параметре
Примечание
Чтобы сопоставлять поля JSON и свойства профиля пользователя в Xsolla, а также настроить связывание аккаунтов по ID пользователя на вашем сервере, воспользуйтесь инструкцией.
Пример вебхука:
Copy
Full screen
Small screen
http
- http
- curl
1POST https://your.hostname/your_email_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6 "email": "[email protected]",
7 "type": "email"
8}
1curl --request POST \
2 --url 'https://your.hostname/your_email_authentication_uri' \
3 --header 'authorization: bearer_JWT' \
4 --header 'content-type: application/json' \
5 --data '{"email": "[email protected]","type": "email"}'
Пример ответа на вебхук с атрибутами пользователей:
Copy
Full screen
Small screen
- json
1{
2 "attributes": [
3 {
4 "attr_type": "server",
5 "key": "company",
6 "permission": "private",
7 "value": "facebook-promo"
8 },
9 {
10 "attr_type": "server",
11 "key": "custom-id",
12 "permission": "private",
13 "value": 48582
14 }
15 ]
16}
Пример ответа с объектом JSON:
Copy
Full screen
Small screen
- json
1{
2 "user": {
3 "player_id": "12345678",
4 "email": "[email protected]"
5 },
6 "user_info": {
7 "username": "gamer123",
8 "user_first_name": "John",
9 "user_last_name": "Doe",
10 "gender": "male",
11 "birthday": "1990-05-15",
12 "country": "US",
13 "language": "en"
14 },
15 "subscription_status": "active",
16 "loyalty_level": "gold"
17
18}
- Клиент открывает форму аутентификации и предлагает пользователю ввести email-адрес.
- Пользователь вводит свой email-адрес.
- Клиент отправляет
POST-запросStart auth by email на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметры:
response_type— тип получения JWT, передайте значениеcode;client_id— ID клиента OAuth 2.0;state— значение, которое используется для дополнительной аутентификации пользователя. Необходимо для предотвращения атак CSRF. Значение возвращается в ответе, допустимая длина: от 1 до 8 символов.
- body-параметр
email— email-адрес пользователя.
- query-параметры:
- Клиент предлагает пользователю ввести код подтверждения.
- Пользователь вводит полученный код.
- Клиент отправляет
POST-запросComplete auth by email на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
client_id— ID клиента OAuth 2.0; - body-параметры:
code— код подтверждения;phone_number— номер телефона пользователя;operation_id— ID кода подтверждения.
- query-параметр
- Если это первая авторизация пользователя, сервер Xsolla Login отправляет вебхук на URL для входа без пароля. Ответ на вебхук должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя. - В случае неуспешной аутентификации пользователя вы можете передать сообщение об ошибке, которое будет отображено в виджете авторизации. Для этого в ответе на вебхук для создания пользователя передайте объект
error, в котором:- В параметре
codeукажите код ошибки, например011-002. - В параметре
descriptionукажите текст ошибки.
- В параметре
Пример вебхука:
Примечание
Чтобы сопоставлять поля JSON и свойства профиля пользователя в Xsolla, а также настроить связывание аккаунтов по ID пользователя на вашем сервере, воспользуйтесь инструкцией.
Copy
Full screen
Small screen
http
- http
- curl
1POST https://your.hostname/your_email_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6 "email": "[email protected]",
7 "type": "email"
8}
1curl --request POST \
2 --url 'https://your.hostname/your_email_authentication_uri' \
3 --header 'authorization: bearer_JWT' \
4 --header 'content-type: application/json' \
5 --data '{"email": "[email protected]","type": "email"}'
Пример ответа на вебхук с атрибутами пользователей:
Copy
Full screen
Small screen
- json
1{
2 "attributes": [
3 {
4 "attr_type": "server",
5 "key": "company",
6 "permission": "private",
7 "value": "facebook-promo"
8 },
9 {
10 "attr_type": "server",
11 "key": "custom-id",
12 "permission": "private",
13 "value": 48582
14 }
15 ]
16}
Пример ответа с объектом JSON:
Copy
Full screen
Small screen
- json
1{
2 "user": {
3 "player_id": "12345678",
4 "email": "[email protected]"
5 },
6 "user_info": {
7 "username": "gamer123",
8 "user_first_name": "John",
9 "user_last_name": "Doe",
10 "gender": "male",
11 "birthday": "1990-05-15",
12 "country": "US",
13 "language": "en"
14 },
15 "subscription_status": "active",
16 "loyalty_level": "gold"
17
18}
Аутентификация через социальные сети
Примечание
Для получения информации о пользователе при аутентификации через социальные сети задайте URL для входа через социальные сети в настройках вашего варианта авторизации в Личном кабинете (раздел База пользователей > Хранилище > Собственное хранилище). На него будет отправляться запрос с данными, полученными от социальной сети.
Сценарий аутентификации:
- Клиент отправляет
POST-запросAuth via social network на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в Личном кабинете; - path-параметр
provider_name— название социальной сети, подключенной в Личном кабинете. Возможные варианты:amazon,apple,xsolla,baidu,battlenet,discord,epicgames,facebook,github,google,kakao,linkedin,mailru,microsoft,msn,naver,ok,paypal,qq,reddit,steam,twitch,twitter,vimeo,vk,wechat,weibo,xbox,yahoo,yandex.
- query-параметр
- Пользователь выполняет аутентификацию в социальной сети.
- Сервер Xsolla Login обрабатывает данные пользователя, полученные от социальной сети, и отправляет вебхук на URL для входа через социальные сети. Ответ на вебхук должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя.
Для получения информации о пользователе при аутентификации через социальные сети задайте URL для входа через социальные сети в настройках вашего варианта авторизации в аккаунте для мобильных игр (раздел База пользователей > Хранилище > Собственное хранилище). На него будет отправляться запрос с данными, полученными от социальной сети.
Сценарий аутентификации:
- Клиент отправляет
POST-запросAuth via social network на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в аккаунте для мобильных игр; - path-параметр
provider_name— название социальной сети, подключенной в аккаунте для мобильных игр. Возможные варианты:amazon,apple,xsolla,baidu,battlenet,discord,epicgames,facebook,github,google,kakao,linkedin,mailru,microsoft,msn,naver,ok,paypal,qq,reddit,steam,twitch,twitter,vimeo,vk,wechat,weibo,xbox,yahoo,yandex.
- query-параметр
- Пользователь выполняет аутентификацию в социальной сети.
- Сервер Xsolla Login обрабатывает данные пользователя, полученные от социальной сети, и отправляет вебхук на URL для входа через социальные сети. Ответ на вебхук должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя.
Для получения данных пользователя при аутентификации через социальные сети укажите Social Login URL в настройках вашего варианта авторизации в аккаунте (раздел User database > Storage > Custom storage). На этот URL будет отправляться запрос с данными, полученными от социальной сети.
Для получения данных пользователя при аутентификации через социальные сети укажите Social Login URL в настройках вашего варианта авторизации в аккаунте (раздел User database > Storage > Custom storage). На этот URL будет отправляться запрос с данными, полученными от социальной сети.
Для получения данных пользователя при аутентификации через социальные сети укажите Social Login URL в настройках вашего варианта авторизации в аккаунте (раздел User database > Storage > Custom storage). На этот URL будет отправляться запрос с данными, полученными от социальной сети.
Сценарий аутентификации:
- Клиент отправляет
Auth via social network POST-запрос на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в вашем аккаунте. - path-параметр
provider_name— название социальной сети, подключенной к варианту авторизации в вашем аккаунте. Возможные варианты:amazon,apple,xsolla,baidu,battlenet,discord,epicgames,facebook,github,google,kakao,linkedin,mailru,microsoft,msn,naver,ok,paypal,qq,reddit,steam,twitch,twitter,vimeo,vk,wechat,weibo,xbox,yahoo,yandex,youtube.
- query-параметр
- Пользователь выполняет вход в социальную сеть.
- Сервер Xsolla Login обрабатывает данные пользователя, полученные от социальной сети, и отправляет вебхук на Social Login URL. Ответ должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя.
Примечание
Чтобы сопоставлять поля JSON и свойства профиля пользователя в Xsolla, а также настроить связывание аккаунтов по ID пользователя на вашем сервере, воспользуйтесь инструкцией.
Пользовательские данные передаются в заголовке Authorization в виде временного gateway-токена (серверного токена с параметром “request_type”: “gateway_token”).
Основные поля gateway-токена:
| Поле | Тип | Описание |
|---|---|---|
| exp | Unix Timestamp | Дата и время истечения JWT. Срок жизни JWT — 7 минут. Обязательный. |
| iat | Unix Timestamp | Дата и время выдачи JWT. Обязательный. |
| iss | string | Сервис, подписавший JWT: https://login.xsolla.com. Обязательный. |
| request_type | string | Константа: gateway_request. Обязательный. |
| xsolla_login_project_id | string (UUID) | ID вашего варианта авторизации в Личном кабинете. Обязательный. |
| string | Email-адрес пользователя. | |
| sub | string (UUID) | ID пользователя, записанный на стороне сервера Xsolla Login. Обязательный. |
| username | string | Имя пользователя. |
| provider | string | Имя социальной сети, через которую пользователь авторизовался. Обязательный. |
| id | string | ID пользователя в социальной сети. Обязательный. |
| social_access_token | string | Токен доступа социальной сети, через которую аутентифицировался пользователь. Чтобы подключить передачу этого поля, обратитесь к персональному менеджеру проекта или напишите на [email protected]. |
| partner_data | string | Данные любого типа, возвращаемые вашим сервером в теле ответа во время аутентификации. Чтобы подключить передачу этого поля, обратитесь к персональному менеджеру проекта или напишите на [email protected]. |
| Поле | Тип | Описание |
|---|---|---|
| exp | Unix Timestamp | Дата и время истечения JWT. Срок жизни JWT — 7 минут. Обязательный. |
| iat | Unix Timestamp | Дата и время выдачи JWT. Обязательный. |
| iss | string | Сервис, подписавший JWT: https://login.xsolla.com. Обязательный. |
| request_type | string | Константа: gateway_request. Обязательный. |
| xsolla_login_project_id | string (UUID) | ID вашего варианта авторизации в аккаунте. Обязательный. |
| string | Email-адрес пользователя. | |
| sub | string (UUID) | ID пользователя, записанный на стороне сервера Xsolla Login. Обязательный. |
| username | string | Имя пользователя. |
| provider | string | Имя социальной сети, через которую пользователь авторизовался. Обязательный. |
| id | string | ID пользователя в социальной сети. Обязательный. |
| social_access_token | string | Токен доступа социальной сети, через которую аутентифицировался пользователь. Чтобы подключить передачу этого поля, обратитесь к персональному менеджеру проекта или напишите на [email protected]. |
| partner_data | string | Данные любого типа, возвращаемые вашим сервером в теле ответа во время аутентификации. Чтобы подключить передачу этого поля, обратитесь к персональному менеджеру проекта или напишите на [email protected]. |
Пример полезных данных токена:
Copy
Full screen
Small screen
- json
1{
2 "exp": 1573635020,
3 "iat": 1573634600,
4 "iss": "https://login.xsolla.com",
5 "request_type": "gateway_request",
6 "xsolla_login_project_id": "00000000-0000-0000-0000-000000000000",
7 "sub": "00000000-0000-0000-0000-000000000000",
8 "email": "[email protected]",
9 "username": "Smith707",
10 "provider": "google",
11 "id": "123",
12}
Пример вебхука на URL для входа через социальные сети:
Copy
Full screen
Small screen
http
- http
- curl
1POST https://your.hostname/your_social_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{}
1curl --request POST \
2 --url 'https://your.hostname/your_social_authentication_uri' \
3 --header 'authorization: bearer_JWT' \
4 --header 'content-type: application/json'
Пример ответа на вебхук с атрибутами пользователей:
Copy
Full screen
Small screen
- json
1{
2 "attributes": [
3 {
4 "attr_type": "server",
5 "key": "company",
6 "permission": "private",
7 "value": "facebook-promo"
8 },
9 {
10 "attr_type": "server",
11 "key": "custom-id",
12 "permission": "private",
13 "value": 48582
14 }
15 ]
16}
Пример ответа с объектом JSON:
Copy
Full screen
Small screen
- json
1{
2 "user": {
3 "player_id": "12345678",
4 "email": "[email protected]"
5 },
6 "user_info": {
7 "username": "gamer123",
8 "user_first_name": "John",
9 "user_last_name": "Doe",
10 "gender": "male",
11 "birthday": "1990-05-15",
12 "country": "US",
13 "language": "en"
14 },
15 "subscription_status": "active",
16 "loyalty_level": "gold"
17
18}
- В случае неуспешной аутентификации пользователя вы можете передать сообщение об ошибке, которое будет отображено в виджете авторизации. Для этого в ответе на вебхук для создания пользователя передайте объект
error, в котором:- В параметре
codeукажите код ошибки, например011-002. - В параметре
descriptionукажите текст ошибки.
- В параметре
Для получения информации о пользователе при аутентификации через социальные сети задайте URL для входа через социальные сети в настройках вашего варианта авторизации в Личном кабинете (раздел База пользователей > Хранилище > Собственное хранилище). На него будет отправляться запрос с данными, полученными от социальной сети.
Сценарий аутентификации:
- Клиент отправляет
POST-запросAuth via social network на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметры:
response_type— тип получения JWT, передайте значениеcode;client_id— ID клиента OAuth 2.0;state— значение, которое используется для дополнительной аутентификации пользователя. Необходимо для предотвращения атак CSRF. Значение возвращается в ответе, допустимая длина: от 1 до 8 символов.
- path-параметр
provider_name— название социальной сети, подключенной в Личном кабинете. Возможные варианты:amazon,apple,xsolla,baidu,battlenet,discord,epicgames,facebook,github,google,kakao,linkedin,mailru,microsoft,msn,naver,ok,paypal,qq,reddit,steam,twitch,twitter,vimeo,vk,wechat,weibo,xbox,yahoo,yandex,youtube.
- query-параметры:
- Пользователь выполняет аутентификацию в социальной сети.
- Сервер Xsolla Login обрабатывает данные пользователя, полученные от социальной сети, и отправляет вебхук на URL для входа через социальные сети. Ответ на вебхук должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя.
Для получения информации о пользователе при аутентификации через социальные сети задайте URL для входа через социальные сети в настройках вашего варианта авторизации в аккаунте для мобильных игр (раздел База пользователей > Хранилище > Собственное хранилище). На него будет отправляться запрос с данными, полученными от социальной сети.
Сценарий аутентификации:
- Клиент отправляет
POST-запросAuth via social network на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметры:
response_type— тип получения JWT, передайте значениеcode;client_id— ID клиента OAuth 2.0;state— значение, которое используется для дополнительной аутентификации пользователя. Необходимо для предотвращения атак CSRF. Значение возвращается в ответе, допустимая длина: от 1 до 8 символов.
- path-параметр
provider_name— название социальной сети, подключенной в аккаунте для мобильных игр. Возможные варианты:amazon,apple,xsolla,baidu,battlenet,discord,epicgames,facebook,github,google,kakao,linkedin,mailru,microsoft,msn,naver,ok,paypal,qq,reddit,steam,twitch,twitter,vimeo,vk,wechat,weibo,xbox,yahoo,yandex,youtube.
- query-параметры:
- Пользователь выполняет аутентификацию в социальной сети.
- Сервер Xsolla Login обрабатывает данные пользователя, полученные от социальной сети, и отправляет вебхук на URL для входа через социальные сети. Ответ на вебхук должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя.
Для получения данных пользователя при аутентификации через социальные сети укажите Social Login URL в настройках вашего варианта авторизации в аккаунте (раздел User database > Storage > Custom storage). На этот URL будет отправляться запрос с данными, полученными от социальной сети.
Для получения данных пользователя при аутентификации через социальные сети укажите Social Login URL в настройках вашего варианта авторизации в аккаунте (раздел User database > Storage > Custom storage). На этот URL будет отправляться запрос с данными, полученными от социальной сети.
Для получения данных пользователя при аутентификации через социальные сети укажите Social Login URL в настройках вашего варианта авторизации в аккаунте (раздел User database > Storage > Custom storage). На этот URL будет отправляться запрос с данными, полученными от социальной сети.
Сценарий аутентификации:
- Клиент отправляет
Auth via social network POST-запрос на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в вашем аккаунте. - path-параметр
provider_name— название социальной сети, подключенной к варианту авторизации в вашем аккаунте. Возможные варианты:amazon,apple,xsolla,baidu,battlenet,discord,epicgames,facebook,github,google,kakao,linkedin,mailru,microsoft,msn,naver,ok,paypal,qq,reddit,steam,twitch,twitter,vimeo,vk,wechat,weibo,xbox,yahoo,yandex,youtube.
- query-параметр
- Пользователь выполняет вход в социальную сеть.
- Сервер Xsolla Login обрабатывает данные пользователя, полученные от социальной сети, и отправляет вебхук на Social Login URL. Ответ должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя.
Примечание
Чтобы сопоставлять поля JSON и свойства профиля пользователя в Xsolla, а также настроить связывание аккаунтов по ID пользователя на вашем сервере, воспользуйтесь инструкцией.
Пользовательские данные передаются в заголовке Authorization в виде временного gateway-токена (серверного токена с параметром “request_type”: “gateway_token”).
Основные поля gateway-токена:
| Поле | Тип | Описание |
|---|---|---|
| exp | Unix Timestamp | Дата и время истечения JWT. Срок жизни JWT — 7 минут. Обязательный. |
| iat | Unix Timestamp | Дата и время выдачи JWT. Обязательный. |
| iss | string | Сервис, подписавший JWT: https://login.xsolla.com. Обязательный. |
| request_type | string | Константа: gateway_request. Обязательный. |
| xsolla_login_project_id | string (UUID) | ID вашего варианта авторизации в Личном кабинете. Обязательный. |
| string | Email-адрес пользователя. | |
| sub | string (UUID) | ID пользователя, записанный на стороне сервера Xsolla Login. Обязательный. |
| username | string | Имя пользователя. |
| provider | string | Имя социальной сети, через которую пользователь авторизовался. Обязательный. |
| id | string | ID пользователя в социальной сети. Обязательный. |
| social_access_token | string | Токен доступа социальной сети, через которую аутентифицировался пользователь. Чтобы подключить передачу этого поля, обратитесь к персональному менеджеру проекта или напишите на [email protected]. |
| partner_data | string | Данные любого типа, возвращаемые вашим сервером в теле ответа во время аутентификации. Чтобы подключить передачу этого поля, обратитесь к персональному менеджеру проекта или напишите на [email protected]. |
| Поле | Тип | Описание |
|---|---|---|
| exp | Unix Timestamp | Дата и время истечения JWT. Срок жизни JWT — 7 минут. Обязательный. |
| iat | Unix Timestamp | Дата и время выдачи JWT. Обязательный. |
| iss | string | Сервис, подписавший JWT: https://login.xsolla.com. Обязательный. |
| request_type | string | Константа: gateway_request. Обязательный. |
| xsolla_login_project_id | string (UUID) | ID вашего варианта авторизации в аккаунте. Обязательный. |
| string | Email-адрес пользователя. | |
| sub | string (UUID) | ID пользователя, записанный на стороне сервера Xsolla Login. Обязательный. |
| username | string | Имя пользователя. |
| provider | string | Имя социальной сети, через которую пользователь авторизовался. Обязательный. |
| id | string | ID пользователя в социальной сети. Обязательный. |
| social_access_token | string | Токен доступа социальной сети, через которую аутентифицировался пользователь. Чтобы подключить передачу этого поля, обратитесь к персональному менеджеру проекта или напишите на [email protected]. |
| partner_data | string | Данные любого типа, возвращаемые вашим сервером в теле ответа во время аутентификации. Чтобы подключить передачу этого поля, обратитесь к персональному менеджеру проекта или напишите на [email protected]. |
Пример полезных данных токена:
Copy
Full screen
Small screen
- json
1{
2 "exp": 1573635020,
3 "iat": 1573634600,
4 "iss": "https://login.xsolla.com",
5 "request_type": "gateway_request",
6 "xsolla_login_project_id": "00000000-0000-0000-0000-000000000000",
7 "sub": "00000000-0000-0000-0000-000000000000",
8 "email": "[email protected]",
9 "username": "Smith707",
10 "provider": "google",
11 "id": "123",
12}
Пример вебхука на URL для входа через социальные сети:
Copy
Full screen
Small screen
http
- http
- curl
1POST https://your.hostname/your_social_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{}
1curl --request POST \
2 --url 'https://your.hostname/your_social_authentication_uri' \
3 --header 'authorization: bearer_JWT' \
4 --header 'content-type: application/json'
Пример ответа на вебхук с атрибутами пользователей:
Copy
Full screen
Small screen
- json
1{
2 "attributes": [
3 {
4 "attr_type": "server",
5 "key": "company",
6 "permission": "private",
7 "value": "facebook-promo"
8 },
9 {
10 "attr_type": "server",
11 "key": "custom-id",
12 "permission": "private",
13 "value": 48582
14 }
15 ]
16}
Пример ответа с объектом JSON:
Copy
Full screen
Small screen
- json
1{
2 "user": {
3 "player_id": "12345678",
4 "email": "[email protected]"
5 },
6 "user_info": {
7 "username": "gamer123",
8 "user_first_name": "John",
9 "user_last_name": "Doe",
10 "gender": "male",
11 "birthday": "1990-05-15",
12 "country": "US",
13 "language": "en"
14 },
15 "subscription_status": "active",
16 "loyalty_level": "gold"
17
18}
- В случае неуспешной аутентификации пользователя вы можете передать сообщение об ошибке, которое будет отображено в виджете авторизации. Для этого в ответе на вебхук для создания пользователя передайте объект
error, в котором:- В параметре
codeукажите код ошибки, например011-002. - В параметре
descriptionукажите текст ошибки.
- В параметре
Сброс пароля пользователя
- Клиент отправляет
POST-запросReset password на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в Личном кабинете; - body-параметры
username— имя пользователя, допустимая длина: от 3 до 255 символов.
- query-параметр
- Сервер Xsolla Login отправляет письмо пользователю для подтверждения сброса пароля.
- Пользователь подтверждает сброс пароля в письме и переходит на страницу ввода нового пароля.
- Пользователь вводит новый пароль.
- Сервер Xsolla Login отправляет вебхук на URL для сброса пароля.
- В случае неуспешного сброса пароля вы можете передать сообщение об ошибке, которое будет отображено в виджете авторизации. Для этого в ответе на вебхук для создания пользователя передайте объект
error, в котором:- В параметре
codeукажите код ошибки, например011-002. - В параметре
descriptionукажите текст ошибки.
- В параметре
- Клиент отправляет
POST-запросReset password на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в аккаунте для мобильных игр; - body-параметры
username— имя пользователя, допустимая длина: от 3 до 255 символов.
- query-параметр
- Сервер Xsolla Login отправляет письмо пользователю для подтверждения сброса пароля.
- Пользователь подтверждает сброс пароля в письме и переходит на страницу ввода нового пароля.
- Пользователь вводит новый пароль.
- Сервер Xsolla Login отправляет вебхук на URL для сброса пароля.
- В случае неуспешного сброса пароля вы можете передать сообщение об ошибке, которое будет отображено в виджете авторизации. Для этого в ответе на вебхук для создания пользователя передайте объект
error, в котором:- В параметре
codeукажите код ошибки, например011-002. - В параметре
descriptionукажите текст ошибки.
- В параметре
- Клиент отправляет
Reset password POST-запрос на сервер Xsolla Login. Запрос должен содержать следующие обязательные параметры:- query-параметр
projectId— ID варианта авторизации в вашем аккаунте. - body-параметр
username— имя пользователя. Допустимая длина: от 3 до 255 символов.
- query-параметр
- Сервер Xsolla Login отправляет пользователю письмо для подтверждения сброса пароля.
- После подтверждения сброса пароля в письме пользователь перенаправляется на страницу, где он может ввести новый пароль.
- Пользователь вводит новый пароль.
- Сервер Xsolla Login отправляет вебхук на Password reset URL.
- В случае неуспешного сброса пароля вы можете передать сообщение об ошибке, которое будет отображено в виджете авторизации. Для этого в ответе на запрос создания пользователя передайте объект
errorс следующими данными:- В параметре
codeукажите код ошибки, например011-002. - В параметре
descriptionукажите текст ошибки.
- В параметре
Copy
Full screen
Small screen
http
- http
- curl
1POST https://your.hostname/your_reset_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6 "username": "[email protected]",
7 "fields": {
8 "password": "NewPa$$word1"
9 }
10}
1curl --request POST \
2 --url 'https://your.hostname/your_reset_uri' \
3 --header 'authorization: bearer_JWT' \
4 --header 'content-type: application/json' \
5 --data '{"email":"[email protected]","fields":{"password":"NewPa$$word1"}}'
Обновление токена
Примечание
Обновление токена доступно только при использовании протокола аутентификации OAuth 2.0.
- Когда срок действия access-токена истекает, клиент отправляет
POST-запрос Generate JWT на сервер Xsolla Login. Тело запроса должно содержать следующие параметры:grant_type— тип получения JWT, передайте значениеrefresh_token;client_id— ID клиента OAuth 2.0;refresh_token— refresh-токен, полученный в ответ на запрос авторизации пользователя.
- Сервер Xsolla Login отправляет вебхук на URL обновления токена. Ответ на вебхук должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов и/или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле
partner_dataJWT пользователя.
Примечание
Чтобы сопоставлять поля JSON и свойства профиля пользователя в Xsolla, а также настроить связывание аккаунтов по ID пользователя на вашем сервере, воспользуйтесь инструкцией.
Copy
Full screen
Small screen
- http
1POST https://your.hostname/your_refrsh_token_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{}
Пример ответа на вебхук с атрибутами пользователей:
Copy
Full screen
Small screen
- json
1{
2 "attributes": [
3 {
4 "attr_type": "server",
5 "key": "company",
6 "permission": "private",
7 "value": "facebook-promo"
8 },
9 {
10 "attr_type": "server",
11 "key": "custom-id",
12 "permission": "private",
13 "value": 48582
14 }
15 ]
16}
Пример ответа с объектом JSON:
Copy
Full screen
Small screen
- json
1{
2 "user": {
3 "player_id": "12345678",
4 "email": "[email protected]"
5 },
6 "user_info": {
7 "username": "gamer123",
8 "user_first_name": "John",
9 "user_last_name": "Doe",
10 "gender": "male",
11 "birthday": "1990-05-15",
12 "country": "US",
13 "language": "en"
14 },
15 "subscription_status": "active",
16 "loyalty_level": "gold"
17
18}
Была ли статья полезна?
Спасибо за обратную связь!
Ваши мысли и идеи помогут нам улучшить ваш пользовательский опыт.Продолжить чтение
Последнее обновление:
28 августа 2026
Нашли опечатку или ошибку в тексте? Выделите ее и нажмите Ctrl+Enter.
