Iniciar autenticación mediante correo electrónico

Iniciar autenticación mediante correo electrónicoClient-side

post/login/email/request

Inicia la autenticación mediante la dirección de correo electrónico del usuario y envía un código de confirmación a su dirección de correo electrónico. El ciclo de vida del código es de 3 minutos.

Esta llamada solo se utiliza con la llamada Complete auth by email.

El flujo de trabajo empleado con esta llamada es el siguiente:

La aplicación 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.
La aplicación envía la solicitud al servidor de Xsolla Login: a. Si el parámetro send_link es true, después de esta solicitud, deberá enviar la solicitud Get confirmation code para que el correo contenga el código de confirmación y el enlace. b. Si el parámetro send_link es false o no se transmite, el correo contendrá solo el código de confirmación.
El servidor de Xsolla Login envía el correo electrónico y devuelve el ID del código de confirmación.
La aplicación indica un campo para que el usuario ingrese el código de confirmación.
El usuario introduce el código de confirmación recibido o sigue el enlace.
La aplicación envía la solicitud Complete auth by email al servidor de Xsolla Login con el ID recibido.
Al usuario se le considera autorizado.

Request

query Parameters

projectId required	string <uuid> ID del proyecto de Login procedente de Cuenta del editor.
login_url	string URL to redirect the user to after account confirmation, successful authentication, two-factor authentication configuration, or password reset confirmation. Must be identical to the Callback URL specified in the URL block of Publisher Account. For the scenario of a login error, the value should be identical to the the Error callback URL specified in the URL block of Publisher Account. To find the settings, go to Login > your Login project and select the Callback URLs section in the upper block. Required if there are several Callback URLs.
payload	string Sus datos personalizados. El valor del parámetro será devuelto en la notificación `payload` del user JWT (JWT de usuario). Longitud máxima recomendada inferior a 500 caracteres. Tenga en cuenta que este parámetro únicamente está disponible si usa un almacenamiento de datos de usuario personalizado.
with_logout	string Default: "0" Indica si se desactivan los valores del JWT de usuario existentes y si se activa el valor generado por esta llamada. Puede tener los siguientes valores: "1" para desactivar los valores existentes y activar uno nuevo, "0" para mantener activados los valores existentes.

Request Body schema: application/json

email required	string [ 1 .. 255 ] characters Dirección de correo electrónico del usuario.
link_url	string <uri> URL para redirigir al usuario a la página de autenticación de estado. Required (Obligatoria) si el parámetro `send_link` es `true`.
send_link	boolean Indica si se envía o no un enlace con el código de confirmación en el correo electrónico. Se puede utilizar el enlace en lugar del código de confirmación para iniciar sesión. Si el parámetro tiene el valor `true`, el enlace se envía en el correo electrónico.

Responses

200

ACEPTAR

400

bad request (solicitud errónea)

404

Not Found (No encontrado)

422

Unprocessable Entity (Entidad no procesable)

429

Too Many Requests (Demasiadas solicitudes)

Request samples

application/json

{"email": "string",
"link_url": "http://example.com",
"send_link": true
}

Response samples

application/json

{"operation_id": "string"
}