Autorizar inicio de sesión de usuario
API operation: Open the endpoint in Scalar
Usa POST /auth para autenticar a un usuario registrado. La operación pública actual es User.auth.
La solicitud admite inicio de sesión por email o cellphone. Se requiere una contraseña normal o una contraseña de un solo uso, según el modo de inicio de sesión seleccionado. Los campos adicionales, incluidos los de notificación, código de dispositivo y verificación, son condicionales; sigue el esquema de solicitud de Scalar en vez de enviar todos los campos disponibles.
Ejemplo de email y contraseña:
const response = await ordering.users().auth({
email: 'user@example.com',
password: '[REDACTED]'
})
El inicio de sesión por cellphone requiere un número asociado con un usuario registrado y los campos de código de país requeridos por la configuración del proyecto seleccionado.
Esta guía agrega contexto de uso a la operación pública exacta POST /auth. Scalar sigue siendo la fuente de autoridad para los campos de solicitud, requisitos de autenticación, respuestas y errores.
Referencia de OpenAPI
Operación: POST /auth
Parámetros de encabezado
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
x-forwarded-for | string | No | — |
User-Agent | string | No | — |
Campos del cuerpo de la solicitud
| Nombre | Tipo | Obligatorio |
|---|---|---|
cellphone | any | No |
country_phone_code | string | No |
device_code | string | No |
email | any | No |
guest_token | any | No |
notification_app | any | No |
notification_provider | any | No |
notification_token | any | No |
one_time_password | any | No |
password | any | No |
platform | string | No |
recaptcha_type | string | No |
verification_code | any | No |
Respuestas
| Código | Descripción |
|---|---|
| 200 | Envelope de éxito. result es la instancia serializada de User ($fillable menos $hidden). |
| 400 | Respuesta de error (error=true). Los errores de validación y de negocio comparten este código. |
| 401 | Respuesta de error para el código declarado por la operación. Consulta result para ver los detalles disponibles. Envelope de error: el proyecto no existe o no tiene una suscripción activa. |
| 403 | Respuesta de error: el módulo AI no está disponible para este proyecto. |
| 404 | Respuesta vacía: la versión de API solicitada no está admitida. |
| 429 | Envelope de error: se excedió un límite de consumo del proyecto (o el sujeto está baneado). Lleva Retry-After y X-RateLimit-Limit/Remaining/Reset/Scope/Key. |
| 500 | Respuesta de error: falló la búsqueda o inicialización del proyecto. |
| 503 | Envelope de error: la aplicación está temporalmente en mantenimiento. Envelope de error: el proyecto está temporalmente en mantenimiento, o los límites de consumo no se pudieron evaluar y el límite aplicable está configurado con on_error = closed (cabecera Retry-After: 1). |