• Version: 1.0.0
• Servers: https://login.xsolla.com/api
• Protocols: https
• Accepts: application/json
• Responds with: application/json
• Contact us by email
• Contact URL: https://xsolla.com/

Esta sección describe las llamadasAPI para trabajar con Login. Establezca su proyecto de Login en Cuenta del editor antes de enviar solicitudes.

Puede descargar la definición de API en dos formatos:

• YAML
• JSON

Puede acceder a los siguientes tipos de proyectos de Login en Cuenta del editor:

• Proyecto de Login estándar
• Proyecto de Login concurrente

Para obtener más información al respecto, consulte el artículo Cuenta multiplataforma.

Es un proyecto de Login que se utiliza para almacenar las cuentas principales.

Es un proyecto de Login que se utiliza para almacenar las cuentas de plataforma.

Es un tipo de cuenta que se crea en un proyecto de Login estándar y se vincula a cuentas de plataforma. La cuenta principal se utiliza para identificar al jugador en las diferentes plataformas.

Es un tipo de cuenta que se crea en un proyecto de Login concurrente y se conecta a una plataforma de publicación definida. La cuenta de plataforma no puede vincularse a otra cuenta de plataforma. Tampoco puede desvincularse de una cuenta principal.

Es una plataforma de juegos que se utiliza para la distribución de juegos (p.  ej., Steam, PlayStation, Xbox, etc.).

Login API admite los siguientes tipos de token:

• Token de usuario. Se utiliza para enviar solicitudes a los siguientes recursos de usuario:
  • perfil
  • amigos
  • atributos
• Token de servidor. Se utiliza para enviar solicitudes a los recursos de la aplicación, como configuración o datos de usuario. Están disponibles las siguientes solicitudes:
  • Crear cuentas de plataforma
  • Obtener datos de usuario
  • Vincular cuentas
  • Vincular cuentas de usuario mediante ID externo

Para obtener el token, envíe una de las siguientes solicitudes:

• registro de usuarios (JWT o OAuth 2.0)
• autenticación mediante nombre de usuario y contraseña (JWT, OAuth 2.0 o autenticación de JWT mediante nombre de usuario y contraseña)
• autenticación a través de redes sociales (JWT o OAuth 2.0)
• autenticación silenciosa (JWT o OAuth 2.0)
• autenticación mediante un token de acceso a red social
• autenticación mediante una plataforma de publicación

Tras la autenticación mediante JWT, el usuario es redirigido a la URL de devolución de llamada con un token en un parámetro de consulta: <Callback URL>?token=<User token (JWT)>.

Tras la aunticación basada en el protocolo OAuth 2.0, envíe la solicitud Generate JWT al servidor de Xsolla Login para cambiar el parámetro code recibido por un token de usuario (access_token).

Para obtener un token de servidor:

1. Establezca el servidor cliente de OAuth 2.0.
2. Genere un JWT de servidor.

Establecer el cliente de OAuth 2.0

1. Abra su proyecto en Cuenta del editor y vaya a la sección de Login.
2. Haga clic en Configure en el panel de un proyecto de Login.
3. Vaya al bloque Security y seleccione la sección OAuth 2.0.
4. Click Add OAuth 2.0 Client.
5. Marque la casilla Server (server-to-server connection).
6. Especifique Token lifetime.
7. Haga clic en Connect.
8. Copie y guarde el ID de cliente y la clave secreta.

Generar un JWT de servidor

En el back-end de su aplicación, implemente un método para obtener el JWT de servidor utilizando la llamada Generate JWT API. La solicitud debe contener los siguientes parámetros:

• grant_type is the type of getting JWT, pass the client_credentials value.
• client_secret is the secret key that is received when you set up the server OAuth 2.0 client.
• client_id is the client ID received when you set up the server OAuth 2.0 client.

Cada token tiene un formato de JWT y contiene una información precisa en una carga útil.

El JWT de usuario es un token recibido como resultado de una autenticación o registro. La carga útil de un token contiene información sobre el usuario y la llamada de autenticación.

Obtener un token de usuario mediante el protocolo OAuth 2.0 requiere un cliente de OAuth 2.0. El token de usuario se transmite en el encabezado Authorization: Bearer <JWT>.

Un token contendrá las notificaciones principales tras la autenticación o la confirmación de la dirección de correo electrónico. La presencia de estas notificaciones no depende de la base de datos de usuarios ni de la llamada de autenticación.

 

Notificación	Tipo	Obligatoria	Descripción
exp	Marca de tiempo de Unix	Sí	Fecha y hora de expiración del token. El tiempo de expiración por defecto es de 24 horas. Puede cambiar el tiempo de expiración para cada proyecto de Login.
iss	string	Sí	Servicio que firmó el token: https://login.xsolla.com.
iat	Marca de tiempo de Unix	Sí	Fecha y hora de entrega del token.
sub	string (cadena) (UUID)	Sí	ID de usuario escrito en el lado del servidor de Xsolla Login.
groups	matriz	Sí	La lista de grupos a los que pertenece el usuario. Cada grupo se escribe con el siguiente formato: id - ID del grupo name - nombre del grupo is_default - muestra si se trata de un grupo por defecto o no (valorestrue o false ). Solo puede haber un grupo por defecto. Este grupo incluye inicialmente a todos los usuarios antes de que se distribuyan en diferentes grupos.
xsolla_login_project_id	string (cadena) (UUID)	Sí	ID del proyecto de Login.
type	string		Opciones de autenticación: xsolla_login - inicio de sesión mediante nombre de usuario/correo electrónico y contraseña. social - inicio de sesión mediante redes sociales email - inicio de sesión sin contraseña mediante código de un solo uso recibido por correo electrónico. phone - inicio de sesión sin contraseña mediante un código de un solo uso recibido por SMS. firebase - inicio de sesión mediante nombre de usuario/correo electrónico y contraseña cuando el almacenamiento de datos del usuario es Firebase. playfab - Inicio de sesión mediante nombre de usuario/correo electrónico y contraseña cuando el almacenamiento de datos del usuario es PlayFab. proxy - inicio de sesión a través de nombre de usuario / correo electrónico y contraseña cuando el almacenamiento de datos de usuario es personalizado. device - inicio de sesión con ID de dispositivo. server_custom_id - inicio de sesión con ID personalizado. Solo puede haber un grupo por defecto. Este grupo incluye inicialmente a todos los usuarios antes de que se distribuyan en diferentes grupos.
avatar	string		URL del avatar del usuario.
username	string		Nombre de usuario.
publisher_id	integer		ID de un vendedor propietario de un proyecto de Login.
email	string		Dirección de correo electrónico del usuario.
payload	string		Información adicional que se transmite en el parámetro de carga útil durante la autenticación.
promo_email_agreement	boolean		Puede tener uno de los siguientes valores: true si el usuario acepta recibir un boletín. false en caso contrario. Tiene el valor true por defecto. Para añadir la función al formulario de registro del widget de Login : Contacte con su gestor de cuenta si utiliza el widget 2.0. Agregue el parámetro fields con el valor promo_email_agreement al código de inicialización si utiliza la versión anterior del widget.
connection_information	string		Muestra si el usuario ha confirmado o no su fecha de nacimiento. La confirmación se realiza a través del servicio okname.

Notificaciones contenidas en el token tras la autenticación si utiliza el almacenamiento de PlayFab.

Notificación	Tipo	Obligatoria	Descripción
external_account_id	string	Sí	ID de usuario de PlayFab.
session_ticket	string	Sí	Un parámetro SessionTicket recibido durante una solicitud de autenticación o solicitudes a la PlayFab API. Un token contiene la notificación si autentica a los usuarios mediante el protocolo OAuth 2.0 y transmite el valor playfab al parámetro scope.
entity_token	string	Sí	Un parámetro EntityToken.EntityToken.
entity_type	string	Sí	Un parámetro EntityToken.Entity.Type. Solo puede tener el valor title_player_account.
entity_id	string	Sí	Un parámetro EntityToken.Entity.Id.

Notificaciones contenidas en el token tras la autenticación si utiliza el almacenamiento personalizado.

Notificación	Tipo	Obligatoria	Descripción
provider	string	Sí	Nombre de la red social utilizada para la autenticación. Si el usuario se autentica mediante nombre de usuario y contraseña, la notificación tiene el valor xsolla.
external_account_id	string		ID de usuario en el lado de su servidor.
partner_data			Datos de cualquier tipo devueltos por su servidor en el cuerpo de la respuesta durante la autenticación.

Notificaciones contenidas en el token tras la autenticación a través de una red social. La presencia de estas notificaciones no depende de la base de datos de usuarios.

Notificación	Tipo	Obligatoria	Descripción
provider	string	Sí	Nombre de la red social utilizada para la autenticación.
id	string	Sí	ID de usuario en una red social.
is_cross_auth	boolean		Muestra que la solicitud de autenticación silenciosa está en curso.
social_access_token	string		Parámetro access_token de la cuenta de red social utilizado para la autenticación. Póngase en contacto con su gestor de cuenta para establecer esta función.
picture	string (URL)		Enlace a la foto de perfil del usuario en una red social.
birthday	fecha (RFC3339)		Fecha de nacimiento del usuario en una red social.
gender	string		Sexo/género de los usuarios en una red social.
name	string		Apodo del usuario en una red social.

Notificaciones contenidas en el token tras la autenticación OAuth 2.0.

Notificación	Tipo	Obligatoria	Descripción
jti	string	Sí	ID de token único.

Notificación que contiene el token tras la autenticación mediante un número de teléfono.

Notificación	Tipo	Obligatoria	Descripción
phone_number	string	Sí	Número de teléfono del usuario utilizado para la autenticación. El formato del número de teléfono se basa en el código de país, el distintivo de zona y el número de línea sin separadores.

El token del servidor se transmite en el encabezado X-SERVER-AUTHORIZATION.

La carga útil del token contiene información sobre los recursos que posee el cliente de OAuth 2.0. El token tiene acceso a llamadas con autenticación basada en servidor para estos recursos.

Notificación	Tipo	Obligatoria	Descripción
xsolla_login_project_id	string (cadena) (UUID)	Sí	ID de un proyecto de Login que posee el cliente de OAuth 2.0.
resources	matriz	Sí	Lista de recursos propiedad de un cliente de OAuth 2.0. Posibles tipos de recursos: publisher_id - recursos de un vendedor propietario del proyecto de Login publisher_project_id - recursos de un proyecto en Cuenta del editor. Cada grupo se escribe en el siguiente formato: name - tipo de recurso value - ID del recurso
jti	string	Sí	ID de token único.

Tras una autenticación correcta, se genera un JWT para cada usuario. El JWT generado está firmado mediante una clave secreta. Para asegurarse de que un JWT es relevante y pertenece al usuario de su proyecto de Login, debe validar su valor.

Para validar un JWT:

1. Abra su proyecto en Cuenta del editor y vaya a la sección Login.
2. Haga clic en Configure en el panel de una opción de Login.
3. En la página de navegación, vaya al bloque Security y seleccione la sección JWT Signature.
4. Seleccione su método de cifrado y copie el valor del campo Secret key o New public JSON Web Key, en función del método seleccionado.
5. Elija la biblioteca y conéctela en el lado del servidor de su aplicación.
6. Transmita el valor, copiado en el paso 4, a la entrada de la función de validación.

En caso de respuestas de error, el servidor Xsolla Login devuelve un objeto JSON con los siguientes campos:

Campo	Tipo	Descripción
código	string	Código de error del servidor de Xsolla Login.
descripción	string	Descripción del error. El texto está siempre en inglés. No utilice este texto en caso de error, ya que el valor puede cambiar en el futuro.

{
  "error": {
    "code": "000-000",
    "description": "description"
  }
}