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

При использовании собственного хранилища вам доступны:

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

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

В качестве клиента может выступать виджет авторизации Xsolla или ваше приложение, которое использует методы Login API. Сценарий взаимодействия клиента и сервера Xsolla Login:

1. Клиент отправляет запросы на сервер Xsolla Login. Формат запросов описан в группах методов JWT и Password.
2. Сервер Xsolla Login отправляет запросы на ваш сервер. Для валидации запросов используйте инструкцию.
3. Сервер Xsolla Login обрабатывает ответ от вашего сервера и возвращает результат клиенту.
4. Клиент обрабатывает ответ.

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

Регистрация пользователя

1. Клиент отправляет запрос Register new user на сервер Xsolla Login.
2. Сервер Xsolla Login отправляет запрос на URL для создания пользователя. Ответ на запрос должен иметь формат, описанный в инструкции. В ответе вы можете указать список пользовательских атрибутов.

Пример запроса на URL для создания пользователя:

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

{
  "email": "john@gmail.com",
  "password": "123456"
}

curl --request POST \
  --url 'https://your.hostname/your_registration_uri' \
  --header 'authorization: bearer_JWT' \
  --header 'content-type: application/json' \
  --data '{"email":"john@gmail.com","password":"123456"}'

Пример ответа:

{
    "attributes": [
      {
        "attr_type": "server",
        "key": "company",
        "permission": "private",
        "value": "facebook-promo"
      },
      {
        "attr_type": "server",
        "key": "custom-id",
        "permission": "private",
        "value": 48582
      }
    ]
}

3. Информация о пользователе записывается в базу данных Иксоллы. При этом параметр email отмечается как неподтвержденный. Письмо для подтверждения регистрации отправляется пользователю.
4. Если вы интегрировали виджет авторизации, пользователь перенаправляется на страницу с сообщением: Письмо со ссылкой для подтверждения аккаунта отправлено на {email}.
5. В случае неуспешной регистрации пользователя вы можете передать сообщение об ошибке, которое будет отображено в виджете авторизации. Для этого в ответе на запрос для создания пользователя передайте объект error, в котором:
   • В параметре code укажите 011-002.
   • В параметре description укажите текст ошибки.

{
  "error": {
    "code": "011-002",
    "description": "<string>"
  }
}

Аутентификация по имени пользователя и паролю

1. Клиент отправляет запрос Auth by username and password на сервер Xsolla Login.
2. Сервер Xsolla Login отправляет запрос на URL для проверки существования пользователя. Ответ на запрос должен иметь формат, описанный в инструкции.

Пример запроса на URL для создания пользователя:

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

{
  "email": "john@gmail.com",
  "password": "123456"
}

curl --request POST \
  --url 'https://your.hostname/your_authentication_uri' \
  --header 'authorization: bearer_JWT' \
  --header 'content-type: application/json' \
  --data '{"email":"john@gmail.com","password":"123456"}'

Пример ответа:

{
    "attributes": [
      {
        "attr_type": "server",
        "key": "company",
        "permission": "private",
        "value": "facebook-promo"
      },
      {
        "attr_type": "server",
        "key": "custom-id",
        "permission": "private",
        "value": 48582
      }
    ]
}

3. Сервер Xsolla Login генерирует JWT пользователя.
4. Пользователь перенаправляется на login_url с query-параметром token. В параметр token записывается JWT пользователя.

Аутентификация без пароля по номеру телефона

1. Клиент открывает форму аутентификации и предлагает пользователю ввести номер телефона.
2. Пользователь вводит свой номер телефона.
3. Клиент отправляет запрос Start auth by phone number на сервер Xsolla Login.
4. Клиент предлагает пользователю ввести код подтверждения.
5. Пользователь вводит полученный код.
6. Клиент отправляет запрос Complete auth by phone number на сервер Xsolla Login.
7. Если это первая авторизация пользователя, сервер Xsolla Login отправляет запрос на URL для входа без пароля по номеру телефона. Ответ на запрос должен иметь формат, описанный в инструкции.

Пример запроса на URL для создания пользователя:

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

{
  "login": "+12025550140",
  "type": "phone"
}

curl --request POST \
  --url 'https://your.hostname/your_phone_authentication_uri' \
  --header 'authorization: bearer_JWT' \
  --header 'content-type: application/json' \
  --data '{"login":"+12025550140","type":"phone"}'

Пример ответа:

{
    "attributes": [
      {
        "attr_type": "server",
        "key": "company",
        "permission": "private",
        "value": "facebook-promo"
      },
      {
        "attr_type": "server",
        "key": "custom-id",
        "permission": "private",
        "value": 48582
      }
    ]
}

Аутентификация через социальные сети

Для получения информации о пользователе при аутентификации через социальные сети задайте URL для входа через социальные сети в настройках вашего варианта авторизации в Личном кабинете (раздел База пользователей > Хранилище > Собственное хранилище). На него будет отправляться запрос с данными, полученными от социальной сети.

Сценарий аутентификации:

1. Клиент отправляет запрос Auth via social network на сервер Xsolla Login.
2. Пользователь выполняет аутентификацию в социальной сети.
3. Сервер Xsolla Login обрабатывает данные пользователя, полученные от социальной сети, и отправляет запрос на URL для входа через социальные сети. Ответ на запрос должен иметь формат, описанный в инструкции.

Запрос содержит данные пользователя во временном токене в заголовке Authorization: Bearer <JWT>. JWT пользователя, передаваемый в запросе, содержит следующие данные:

{
  "exp": 1573635020,
  "iat": 1573634600,
  "iss": "https://login.xsolla.com",
  "request_type": "gateway_request",
  "xsolla_login_project_id": "00000000-0000-0000-0000-000000000000",
  "sub": "00000000-0000-0000-0000-000000000000",
  "email": "example@test.com",
  "username": "Smith707",
  "provider": "google",
  "id": "123",
}

Пример запроса на URL для создания пользователя:

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

{}

curl --request POST \
  --url 'https://your.hostname/your_social_authentication_uri' \
  --header 'authorization: bearer_JWT' \
  --header 'content-type: application/json'

Пример ответа:

{
    "attributes": [
      {
        "attr_type": "server",
        "key": "company",
        "permission": "private",
        "value": "facebook-promo"
      },
      {
        "attr_type": "server",
        "key": "custom-id",
        "permission": "private",
        "value": 48582
      }
    ]
}

Сброс пароля пользователя

1. Клиент отправляет запрос Reset password на сервер Xsolla Login.
2. Сервер Xsolla Login отправляет письмо пользователю для подтверждения сброса пароля.
3. Пользователь подтверждает сброс пароля в письме и переходит на страницу ввода нового пароля.
4. Пользователь вводит новый пароль.
5. Сервер Xsolla Login отправляет запрос на URL для сброса пароля. Ответ на запрос должен иметь формат, описанный в инструкции.

Пример запроса на URL для создания пользователя:

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

{
  "username": "john@gmail.com",
  "fields": {
    "password": "NewPa$$word1"
  }
}

curl --request POST \
  --url 'https://your.hostname/your_reset_uri' \
  --header 'authorization: bearer_JWT' \
  --header 'content-type: application/json' \
  --data '{"email":"john@gmail.com","fields":{"password":"NewPa$$word1"}}'

Оценить страницу

Что может сделать страницу еще лучше? Отправить

В другой раз

Спасибо за обратную связь!

Продолжить чтение