La comunicación entre la aplicación del cliente y la API de clarisa es segura, antes de poder mandar peticiones a la API es necesario loguearse con (usuario ) y una contraseña.
Clarisa ofrece una API que le permite a su sistema autenticarse .
Autenticación
CABECERAS:
| CABECERAS | VALOR |
| Content-Type | application/json |
METODO: "POST"
CUERPO:
| Nombre del campo | Formato | Tamaño | Descripción |
|---|---|---|---|
| usuario | Alfanúmerico | 5 hasta 255 caracteres | Corresponde al usuario proporcionado por clarisa. |
| contrasenia | Alfanumérico | 5 hasta 255 caracteres | Clave que se debe ingresar para iniciar sesión |
Respuesta:
| Nombre | Tipo dato | Descripción |
|---|---|---|
| success | Booleano | Determina si la operación fué exitosa o no |
| titleResponse | Alfanumérico | Título de la respuesta |
| textResponse | Alfanumérico | Texto de la respuesta |
| lastAction | Alfanumérico | Nombre de la acción bajo la cual se respondió esta respuesta |
| data | Datos de respuesta | |
| data.usuario | Datos de usuario logueado | |
| data.usuario.userName | Alfanumérico | Nombre de usuario logueado |
| data.token | Alfanumérico | Token de usuario |
| data.permisos | Array Alfanumérico | Arreglo con la lista de permisos del usuario. |
En caso de que no se pueda obtener la información del inicio de sesión se debe tener en cuenta la variable success y los valores detitle_response y text_response para poder mostrar los mensajes respectivos al usuario. La variable title_response contiene el código del error y la variable text_response contiene la descripción del error la cual debe ser mostrada al usuario. Si es errores por validación de datos en data se retorna el total de errores y un array con los errores.
RESPUESTA TOKEN:
Tiene una vigencia de 12 horas, por favor
guardarlo en el sistema y solo volver a autenticarse cuando sea necesario.
Correcto
En caso de que la petición se ejecute sin errores se devolverá la siguiente respuesta:
CÓDIGO HTTP: 200
Error
Si la solicitud no es correcta, recibirá la siguiente respuesta:
CÓDIGO HTTP: 401