Documentación API
Auth
POST/auth/login
Descripción:
Este endpoint permite a los usuarios autenticarse en la plataforma utilizando credenciales codificadas en Base64. Las credenciales deben enviarse a través de la cabecera Authorization en el formato Basic <base64-encoded-credentials>, donde las credenciales están compuestas por username:password antes de la codificación.
Request
Json
Response
Json
Propiedades del inicio de sesión
| Propiedad | Tipo | Descripción |
|---|---|---|
| username | string | Nombre de usuario o dirección de correo electrónico para iniciar sesión |
| password | string | Contraseña asociada al nombre de usuario para acceder al sistema |
Propiedades de la respuesta
| Propiedad | Tipo | Descripción |
|---|---|---|
| access_token | string | Token de acceso JWT (JSON Web Token) que contiene la información de autenticación y autorización del usuario |
POST/auth/token?client_id={{client_id}}&client_secret={{client_secret}}&grant_type={{grant_type}}&scope={{scope}}
Descripción:
Este endpoint se utiliza para solicitar un token de autenticación mediante el suministro de credenciales de cliente. La solicitud debe enviarse como una solicitud HTTPS POST a la URL especificada con el ID de cliente, el client secret, el grant_type y el scope como parámetros.
Request
Json
Response
Json
Propiedades del inicio de sesión
| Propiedad | Tipo | Descripción |
|---|---|---|
| client_id | string | Identificador único del cliente que realiza la solicitud de autenticación |
| client_secret | string | Clave secreta del cliente para la autenticación segura |
| grant_type | string | Tipo de autorización solicitada; en este caso, "client_credentials" para autenticación con credenciales de cliente |
| scope | string | Alcance de la autenticación; define los permisos o accesos requeridos, en este caso, "master" |
Propiedades de la respuesta
| Propiedad | Tipo | Descripción |
|---|---|---|
| access_token | string | Token de acceso JWT (JSON Web Token) que contiene la información de autenticación y autorización del usuario |