Iniciar autenticación mediante número de teléfono

post/login/phone/request

Inicia la autenticación mediante el número de teléfono del usuario y envía un código de confirmación a su número de teléfono. El ciclo de vida del código es de 3 minutos.

Esta llamada solo se utiliza con la llamada Complete auth by phone number.

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 número de teléfono.
El usuario introduce su número de teléfono.
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 SMS contenga el código de confirmación y el enlace. b. Si el parámetro send_link es false o no se transmite, el SMS contendrá solo el código de confirmación.
El servidor de Xsolla Login envía el SMS 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 phone number 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 a la que se debe redirigir al usuario tras la confirmación de la cuenta, la autenticación correcta, la configuración de la autenticación de dos factores o la confirmación del restablecimiento de la contraseña. Debe ser idéntica a la URL de devolución de llamada especificada en el bloque de URL de Cuenta del editor. Para encontrarla, vaya a Login > your Login project y seleccione la sección Callback URLs en el bloque superior de la página de navegación. Es Required (obligatoria) si hay varias URL de devolución de llamada.
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

phone_number required	string^\+(\d){5,25}$ Número de teléfono 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 SMS. El enlace puede utilizarse 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 SMS.

Responses

200

ACEPTAR

404

Not Found (No encontrado)

422

Unprocessable Entity (Entidad no procesable)

429

Too Many Requests (Demasiadas solicitudes)

Request samples

application/json

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

Response samples

application/json

{"operation_id": "string"
}