Almacenamiento personalizado de datos de usuarios
Si usa un almacenamiento de datos de usuario personalizado, Xsolla Login interviene como intermediario y todos los datos de identificación del usuario se almacenan en su lado. Xsolla Login transmite los datos de autenticación en el token que se incluye en el encabezado de los webhooks y en sus cuerpos.
- registro de usuario
- autenticación mediante nombre de usuario y contraseña
- autenticación sin contraseña mediante número de teléfono
- autenticación sin contraseña mediante correo electrónico
- autenticación mediante redes sociales
- [restablecimiento de contraseña de usuario
POST
realizadas desde Xsolla no llegan a las URL como http://localhost:3000/my-webhook-endpoint
. Ngrok le permite crear un túnel de acceso externo, permitiéndole recibir solicitudes de Xsolla localmente. Puede obtener más información en la documentación de ngrok.
Si está probando la integración localmente, las solicitudes POST
realizadas desde Xsolla no llegan a las URL como http://localhost:3000/my-webhook-endpoint
. Ngrok le permite crear un túnel de acceso externo, permitiéndole recibir solicitudes de Xsolla localmente. Puede obtener más información en la documentación de ngrok.Flujo de interacción
Puede utilizar el widget de inicio de sesión o su aplicación, que usa las llamadas de Login API como un cliente. El flujo de interacción entre el cliente y el servidor de Xsolla Login es el siguiente:
- El cliente envía solicitudes al servidor de Xsolla Login. El formato de las solicitudes se describe en los puntos finales JWT y Password.
- El servidor de Xsolla Login envía solicitudes a su servidor. El encabezado incluye un JWT del servidor con el parámetro
“request_type”: “gateway_token”
. Para configurar la validación del token, siga las instrucciones. Para configurar la validación de tókenes, siga las instrucciones. Una parte de los datos de identificación del usuario se transmite en el cuerpo del webhook. - Para confirmar la recepción del webhook, su servidor debe devolver: el código HTTP
200
,201
o204
con la descripción del problema si no se encontró el usuario especificado o se transmitió una firma no válida. Su controlador del webhook también puede devolver un código HTTP5xx
si se producen problemas temporales en su servidor.
- El servidor de Xsolla Login procesa una respuesta de su servidor y devuelve el token de autorización al cliente.
- El cliente procesa la respuesta.
Si desea agregar información del usuario al JWT tras la identificación del usuario, devuelva un objeto JSON con cualquier conjunto de parámetros en el cuerpo de la respuesta. Este objeto se guardará en el campo partner_data
del JWT.
- dirección de correo electrónico
- alias
- fecha de nacimiento
- nombre
- apellidos
- D de usuario en su servidor
Parámetro | Tipo | Descripción |
---|---|---|
attr_type | string | Definición del nivel de acceso del usuario a los atributos de servicio:
|
clave | string | El nombre del atributo que se utiliza para identificar el atributo del usuario. Debe ser único para cada usuario. Longitud máxima: 256 símbolos. Se pueden utilizar números, caracteres latinos, guiones y guiones bajos. |
permiso | string o null | El tipo de acceso a los atributos del usuario afecta a la lista de atributos devuelta por los métodos:
Valores posibles: public y private (por defecto). |
read_only | string | Si el atributo está protegido, o no, de las modificaciones. Por defecto, se permite false y cambiar los valores del atributo. |
valor | string | El valor del atributo de usuario. Longitud máxima: 256 símbolos. |
Registro de usuarios
- El cliente envía la solicitud de
Register new user POST
al servidor de Xsolla Login. La solicitud debe incluir el encabezadoAuthorization: Bearer {JWT}
y los siguientes parámetros obligatorios:- El parámetro de consulta
projectId
: ID del proyecto de Login en Cuenta del editor. - Parámetros del cuerpo:
username
: nombre de usuario. Longitud permitida: de 3 a 255 caracteres.password
: contraseña de usuario. Longitud permitida: de 6 a 100 caracteres.email
- dirección de correo electrónico. del usuario. Longitud permitida: de 1 a 255 caracteres.
- El parámetro de consulta
- El servidor de Xsolla Login envía un webhook a la URL de nuevo usuario. La respuesta debe tener el formato descrito en este flujo de interacción. En la respuesta, se puede especificar una lista de atributos de usuario o cualquier objeto JSON necesario. El objeto JSON que proporcione en la respuesta se registra en el campo
partner_data
del JWT del usuario.
Ejemplo de webhook:
http
- http
- curl
1POST https://your.hostname/your_registration_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6 "email":"j.smith@email.com",
7 "password":"123456",
8 "username":"j.smith@email.com"
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":"j.smith@email.com","password":"123456","username":"j.smith@email.com"}'
Ejemplo de respuesta a un webhook con atributos de usuario:
- 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}
Ejemplo de respuesta a un webhook con un objeto JSON:
- json
1{
2 "id": 123456,
3 "role": "scout"
4}
- Los datos del usuario se escriben en la base de datos de Xsolla, mientras que el
email
se marca como sin confirmar. El usuario recibirá un correo electrónico de confirmación de la cuenta. - Si ha integrado el widget de Login, se redirigirá al usuario a la página con el siguiente mensaje: Por favor, confirma tu cuenta siguiendo las instrucciones que enviamos a {email}.
- Si el registro del usuario no se realiza correctamente, puede proporcionar un mensaje de error que se mostrará en el widget de autenticación. Para ello, en la respuesta a la solicitud de creación del usuario, transmita un objeto de
error
con los siguientes detalles:- en el parámetro de
code
, especifique011-002
. - En el parámetro de
description
, facilite el texto del mensaje de error.
- en el parámetro de
- json
1{
2 "error": {
3 "code": "011-002",
4 "description": "<string>"
5 }
6}
Autenticación mediante nombre de usuario y contraseña
- El cliente envía la solicitud
Auth by username and password POST
al servidor de Xsolla Login. La solicitud debe incluir el encabezadoAuthorization: Bearer {JWT}
y los siguientes parámetros obligatorios:- El parámetro de consulta
projectId
: ID del proyecto de Login en Cuenta del editor. - Parámetros del cuerpo:
username
: nombre de usuario. Longitud permitida: de 3 a 255 caracteres.password
: contraseña de usuario. Longitud permitida: de 6 a 100 caracteres.
- El parámetro de consulta
- El servidor de inicio de sesión de Xsolla envía un webhook a la URL de verificación de usuario. La respuesta debe tener el formato descrito en este flujo de interacción. En la respuesta, se puede especificar una lista de atributos de usuario o cualquier objeto JSON necesario. El objeto JSON que proporcione en la respuesta se registra en el campo
partner_data
del JWT del usuario.
Ejemplo de webhook de URL de verificación del usuario:
http
- http
- curl
1POST https://your.hostname/your_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6 "email":"j.smith@email.com",
7 "password":"123456",
8 "username":"j.smith@email.com"
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":"j.smith@email.com","password":"123456","username":"j.smith@email.com"}'
Ejemplo de respuesta a un webhook con atributos de usuario:
- 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}
Ejemplo de respuesta a un webhook con un objeto JSON:
- json
1{
2 "id": 123456,
3 "role": "scout"
4}
- Si la autenticación del usuario no se realiza adecuadamente, puede mostrar un mensaje de error en el widget de autenticación. Para hacerlo, en la respuesta a la solicitud de creación de un usuario, transmita el objeto
error
con los siguientes detalles:- En el parámetro de
code
, especifique un código de error; por ejemplo,011-002
. - En el parámetro de
description
, facilite el texto del mensaje de error.
- En el parámetro de
- El servidor de Xsolla Login genera un JWT de usuario.
- El usuario es redirigido a la
login_url
con un parámetro de consultatoken
. El parámetrotoken
contiene el JWT de usuario.
Autenticación sin contraseña mediante número de teléfono
- El cliente abre un formulario de autenticación para que el usuario pueda introducir su número de teléfono.
- El usuario introduce su número de teléfono.
- El cliente envía la solicitud
Start auth by phone number POST
al servidor de Xsolla Login. La solicitud debe incluir el encabezadoAuthorization: Bearer {JWT}
y los siguientes parámetros obligatorios:- El parámetro de consulta
projectId
: ID del proyecto de Login en Cuenta del editor. - El parámetro del cuerpo
phone_number
: número de teléfono del usuario.
- El parámetro de consulta
- El cliente muestra un campo para que el usuario pueda rellenar el código de verificación.
- El usuario introduce el código de verificación recibido
- El cliente del juego envía la solicitud de
Complete auth by phone number POST
al servidor de Xsolla Login. La solicitud debe incluir el encabezadoAuthorization: Bearer {JWT}
y los siguientes parámetros obligatorios:- El parámetro de consulta
projectId
: el ID del proyecto de Login en Cuenta del editor. - - Parámetros del cuerpo:
code
- código de confirmación.phone_number
- número de teléfono del usuario.operation_id
- ID del código de confirmación.
- El parámetro de consulta
- Si es la primera autorización del usuario, el servidor de Xsolla Login envía un webhook a URL de inicio de sesión sin contraseña. La respuesta debe tener el formato descrito en este flujo de interacción. En la respuesta, se puede especificar una lista de atributos de usuario o cualquier objeto JSON necesario. El objeto JSON que proporcione en la respuesta se registra en el campo
partner_data
del JWT del usuario. - Si la autenticación del usuario no se supera, puede proporcionar un mensaje de error que se mostrará en el widget de autenticación. Para ello, en la respuesta a la solicitud de creación del usuario, transmita el objeto
error
con los siguientes detalles:- En el parámetro de
code
, especifique un código de error; por ejemplo,011-002
. - En el parámetro de
description
facilite el texto del mensaje de error.
- En el parámetro de
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"}'
Ejemplo de respuesta a un webhook con atributos de usuario:
- 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}
Ejemplo de respuesta a un webhook con un objeto JSON:
- json
1{
2 "id": 123456,
3 "role": "scout"
4}
Autenticación sin contraseña con correo electrónico
- El cliente abre un formulario de autenticación para que el usuario pueda introducir su dirección de correo electrónico.
- El usuario introduce su dirección de correo electrónico.
- El cliente envía la solicitud
Start auth by email POST
al servidor de Xsolla Login. La solicitud debe incluir el encabezadoAuthorization: Bearer {JWT}
y los siguientes parámetros obligatorios:- El parámetro de consulta
projectId
: ID del proyecto de Login en Cuenta del editor. - El parámetro del cuerpo
email
: dirección de correo electrónico del usuario.
- El parámetro de consulta
- El cliente muestra un campo para que el usuario pueda rellenar el código de verificación.
- El usuario introduce el código de verificación recibido
- El cliente del juego envía la solicitud de
Complete auth by email POST
al servidor de Xsolla Login. La solicitud debe incluir el encabezadoAuthorization: Bearer {JWT}
y los siguientes parámetros obligatorios:- El parámetro de consulta
projectId
: el ID del proyecto de Login en Cuenta del editor. - - Parámetros del cuerpo:
username
- nombre de usuario. Longitud permitida: de 3 a 255 caracteres.code
- código de confirmaciónemail
- dirección de correo electrónico del usuariooperation_id
- ID del código de confirmación.
- El parámetro de consulta
- Si es la primera autorización del usuario, el servidor de Xsolla Login envía un webhook a URL de inicio de sesión sin contraseña. La respuesta debe tener el formato descrito en este flujo de interacción. En la respuesta, puede especificar una lista de atributos de usuario o cualquier objeto JSON necesario. El objeto JSON que proporcione en la respuesta se registra en el campo
partner_data
del JWT del usuario. - Si la autenticación del usuario no se supera, puede proporcionar un mensaje de error que se mostrará en el widget de autenticación. Para ello, en la respuesta a la solicitud de creación del usuario, transmita el objeto
error
con los siguientes detalles:- En el parámetro de
code
, especifique un código de error; por ejemplo,011-002
. - En el parámetro de
description
facilite el texto del mensaje de error.
- En el parámetro de
Ejemplo de webhook:
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": "user@mail.com",
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": "user@mail.com","type": "email"}'
Ejemplo de respuesta a un webhook con atributos de usuario:
- 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}
Ejemplo de respuesta a un webhook con un objeto JSON:
- json
1{
2 "id": 123456,
3 "role": "scout"
4}
Autenticación mediante redes sociales
Para obtener los datos del usuario al autenticarse a través de redes sociales, especifique la URL de inicio de sesión mediante red social en la configuración de su proyecto de Login en Cuenta del editor (sección User database > Storage > Custom storage). A esta URL se envía una solicitud con los datos recibidos de la red social.
Flujo de autenticación:
- El cliente envía la solicitud
Auth via social network POST
al servidor de Xsolla Login. La solicitud debe incluir el encabezadoAuthorization: Bearer {JWT}
y los siguientes parámetros obligatorios:- El parámetro de consulta
projectId
: ID del proyecto de Login en Cuenta del editor. - El parámetro de ruta de
provider_name
: nombre de la red social conectada a Login en Cuenta de editor. Puede ser:amazon
,apple
,babka
,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
.
- El parámetro de consulta
- El usuario inicia sesión en una red social.
- El servidor de Xsolla Login procesa los datos del usuario recibidos de la red social y envía una solicitud a la URL de inicio de sesión mediante red social. La respuesta debe tener el formato descrito en el flujo de interacción. En la respuesta, se puede especificar una lista de atributos de usuario o cualquier objeto JSON necesario. El objeto JSON que proporcione en la respuesta se registra en el campo
partner_data
del JWT del usuario.
Los datos del usuario se transmiten en el encabezado Authorization
como un token de puerta de enlace temporal (un token de servidor con “request_type”: “gateway_token”)
).
Campos principales del token de puerta de enlace:
Reclamación | Tipo | Descripción |
---|---|---|
exp | Marca de tiempo Unix | La fecha y hora de expiración del JWT. El ciclo de vida del JWT es de 7 minutos. Obligatorio. |
iat | Marca de tiempo Unix | La fecha y la hora en que se emitió el JWT. Obligatorio. |
iss | string | El servicio que firmó el JWT: https://login.xsolla.com . Obligatorio. |
request_type | string | Constante: gateway_request . Obligatorio. |
xsolla_login_project_id | string (cadena) (UUID) | Su ID de proyecto de Login en Cuenta del editor. Obligatorio. |
string | Dirección de correo electrónico del usuario. | |
sub | string (cadena) (UUID) | ID de usuario escrito en el lado del servidor de Xsolla Login. Obligatorio. |
username | string | Nombre de usuario. |
provider | string | Nombre de la red social utilizada para la autenticación. Obligatorio. |
id | string | ID de usuario en una red social. Obligatorio. |
social_access_token | string | Token de acceso de la red social a través de la cual se autenticó el usuario. Para activar la transmisión de esta notificación, contacte con su gestor del éxito del cliente o envíe un correo electrónico a csm@xsolla.com. |
partner_data | string | Datos de cualquier tipo devueltos por su servidor en el cuerpo de la respuesta durante la autenticación. Para activar la transmisión de esta notificación, contacte con su gestor del éxito del cliente o envíe un correo electrónico a csm@xsolla.com. |
- 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": "example@test.com",
9 "username": "Smith707",
10 "provider": "google",
11 "id": "123",
12}
Ejemplo de webhook de URL de inicio de sesión mediante red social:
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'
Ejemplo de respuesta a un webhook con atributos de usuario:
- 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}
Ejemplo de respuesta a un webhook con un objeto JSON:
- json
1{
2 "id": 123456,
3 "role": "scout"
4}
- Si la autenticación del usuario no se realiza adecuadamente, puede facilitar un mensaje de error que se mostrará en el widget de autenticación. Para hacerlo, en la respuesta a la solicitud de creación de un usuario, transmita el objeto
error
con los siguientes detalles:- En el parámetro de
code
, especifique un código de error; por ejemplo,011-002
. - En el parámetro de
description
, facilite el texto del mensaje de error.
- En el parámetro de
Restablecimiento de contraseña de usuario
- El cliente envía la solicitud
Reset password POST
al servidor de Xsolla Login. La solicitud debe incluir el encabezadoAuthorization: Bearer {JWT}
y los siguientes parámetros obligatorios:- El parámetro de consulta
projectId
: - ID del proyecto de Login en Cuenta del editor. - Los parámetros del cuerpo de
username
- nombre de usuario. Longitud permitida: de 3 ta 255 caracteres.
- El parámetro de consulta
- El servidor de Xsolla Login envía al usuario un correo electrónico de confirmación de restablecimiento de contraseña.
- Tras confirmar el restablecimiento de contraseña en el correo electrónico, al usuario se le redirige a la página donde puede introducir una nueva contraseña.
- El usuario introduce una nueva contraseña.
- El servidor de Xsolla Login envía una solicitud a la URL de restablecimiento de contraseña.
- Si el restablecimiento de la contraseña no se realiza correctamente, puede proporcionar un mensaje de error que se mostrará en el widget de autenticación. Para ello, en la respuesta a la solicitud de creación de un usuario, transmita el objeto con los siguientes detalles:
- En el parámetro
code
, especifique un código de error; por ejemplo,011-002
. - En el parámetro
description
proporcione el texto del mensaje de error.
- En el parámetro
Ejemplo de webhook de URL de restablecimiento de contraseña:
http
- http
- curl
1POST https://your.hostname/your_reset_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6 "username": "john@gmail.com",
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":"john@gmail.com","fields":{"password":"NewPa$$word1"}}'
Seguir leyendo
Última actualización: 18 de Junio de 2025¿Has encontrado una errata u otro error de texto? Selecciona el texto y pulsa Ctrl+Intro.