• 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 llamadas API para trabajar con Login. Establezca su proyecto de Login en Cuenta del editor antes de enviar solicitudes.

The full list of IP addresses that login.xsolla.com may use:

• 34.94.0.85
• 34.94.14.95
• 34.94.25.33
• 34.94.115.185
• 34.94.154.26
• 34.94.173.132
• 34.102.48.30
• 35.235.99.248
• 35.236.32.131
• 35.236.35.100
• 35.236.117.164

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.

Son las restricciones aplicadas por la API de Xsolla a la frecuencia de acceso por parte de un usuario en un plazo definido.

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

Puede determinar si una llamada API es del lado del cliente o del lado del servidor por el esquema de autenticación:

• Client-side — are called without authentication or with the Authorization header: Bearer <user_JWT> header, where <user_JWT> — is the user token.
• Server-side API calls for implementing the user flow — are called with the header: X-SERVER-AUTHORIZATION: <server_JWT>, where <server_JWT> — is the server token.

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. Haga clic en 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 es el tipo de obtención del JWT, transmita el valor client_credentials.
• client_secret es la clave secreta que se recibe cuando establece el cliente de OAuth 2.0 del servidor.
• client_id es el ID de cliente recibido al establecer el cliente OAuth 2.0 del servidor.

Para evitar sobrecargas del sistema de Xsolla y protegerlo de ráfagas repentinas de tráfico entrante, Xsolla limita el número de solicitudes recibidas por la API de Xsolla durante un periodo especificado. Si se excede el límite, la API de Xsolla devuelve una respuesta HTTP con el código de estado 429.

Rate limits vary by method, IP-address, authentication scheme, and other factors.

Rate limits for server-side methods are applied to methods with server-side authentication — methods that are called with the X-SERVER-AUTHORIZATION: <server_JWT> header, where <server_JWT> is the server token.

Rate limits for client-side methods are applied to methods without authentication or with client-side authentication — methods that are called with the Authorization: Bearer <user_JWT> header, where <user_JWT> is the user token.

Example of a method with server-side authentication: Example of a method with client-side authentication:

Los límites de frecuencia para los métodos del lado del cliente no cambian y son necesarios para impedir ataques de fuerza bruta. La frecuencia máxima de solicitudes para los métodos del lado del servidor es mayor que para los métodos del lado del cliente. Puede consultar las recomendaciones sobre cómo gestionar los límites de frecuencia en la documentación.

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.

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

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

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.

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

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

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.

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:

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