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

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

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

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

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

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

• В виде любого объекта JSON.

• В виде массива объектов с атрибутами пользователя. Объекты должны иметь следующую структуру:

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

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

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

{
  "email":"j.smith@email.com",
  "password":"123456",
  "username":"j.smith@email.com"
}

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

Пример ответа c атрибутами пользователей:

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

Пример ответа с объектом JSON:

{ "region": "Asia",
  "type": "new"
}

3. Информация о пользователе записывается в базу данных Xsolla. При этом параметр 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-адрес для проверки существования пользователя. Ответ на запрос должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле partner_data JWT пользователя.

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

{
  "email":"j.smith@email.com",
  "password":"123456",
  "username":"j.smith@email.com"
}

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

Пример ответа c атрибутами пользователей:

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

Пример ответа с объектом JSON:

{ "region": "Asia",
  "type": "new"
}

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 для входа без пароля по номеру телефона. Ответ на запрос должен иметь формат, описанный в сценарии взаимодействия. В ответе вы можете указать список пользовательских атрибутов или любой необходимый объект JSON. Объект JSON, переданный вами в ответе, записывается в поле partner_data JWT пользователя.

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"}'

Пример ответа c атрибутами пользователей:

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

Пример ответа с объектом JSON:

{ "region": "Asia",
  "type": "new"
}

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

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

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

{
  "email": "user@mail.com",
  "type": "email"
}

curl --request POST \
  --url 'https://your.hostname/your_email_authentication_uri' \
  --header 'authorization: bearer_JWT' \
  --header 'content-type: application/json' \
  --data '{"email": "user@mail.com","type": "email"}'

Пример ответа c атрибутами пользователей:

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

Пример ответа с объектом JSON:

{ "region": "Asia",
  "type": "new"
}

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

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

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

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

   Чтобы подключить возможность передачи любого объекта JSON в ответе на запрос, обратитесь к персональному менеджеру проекта или напишите на csm@xsolla.com.
   Запрос содержит данные пользователя во временном токене в заголовке Authorization: Bearer <JWT>. JWT пользователя, передаваемый в запросе, содержит следующие данные:

   Поле	Тип	Описание
   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 вашего варианта авторизации в Личном кабинете. Обязательный.
   email	string	Email-адрес пользователя.
   sub	string (UUID)	ID пользователя, записанный на стороне сервера Xsolla Login. Обязательный.
   username	string	Имя пользователя.
   provider	string	Имя социальной сети, через которую пользователь авторизовался. Обязательный.
   id	string	ID пользователя в социальной сети. Обязательный.
   social_access_token	string	Токен доступа социальной сети, через которую аутентифицировался пользователь. Чтобы подключить передачу этого поля, обратитесь к персональному менеджеру проекта или напишите на csm@xsolla.com.
   partner_data	string	Данные любого типа, возвращаемые вашим сервером в теле ответа во время аутентификации. Чтобы подключить передачу этого поля, обратитесь к персональному менеджеру проекта или напишите на csm@xsolla.com.

   Пример полезных данных токена:
   Copy

   Full screen

   Small screen

   • json

   {
     "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-адрес для создания пользователя:

   Copy

   Full screen

   Small screen

   http

   • http
   • curl

   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'
   

   Пример ответа c атрибутами пользователей:

   Copy

   Full screen

   Small screen

   • json

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

   Пример ответа с объектом JSON:

   Copy

   Full screen

   Small screen

   • json

   { "region": "Asia",
     "type": "new"
   }
   

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

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

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

   Copy

   Full screen

   Small screen

   http

   • http
   • curl

   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"}}'
   

   Была ли статья полезна?

   Да

   Нет

   Спасибо!

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

   Жаль, что так произошло

   Расскажите, почему статья не была полезна. Сообщение Отправить

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

   Ваши мысли и идеи помогут нам улучшить ваш пользовательский опыт.

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

   Полезные ссылки

   Как подключить собственное хранилище
   Последнее обновление: 18 декабря 2024

   Нашли опечатку или ошибку в тексте? Выделите ее и нажмите Ctrl+Enter.