Autenticación
LOG IN
Para autenticar a un usuario, la API generará un token de autenticación que será necesario para acceder a cada una de sus funciones. Este token tendrá una duración máxima de 60 segundos sin uso, tras lo cual será necesario generar uno nuevo para continuar utilizando la API.
URL
https://[server]/CTNEAT/LOGIN/{user}/{psw}
Método HTTP
GET
Parámetros de la solicitud
| Nombre del parámetro | Tipo de dato | Descripción del parámetro | Obligatorio |
|---|---|---|---|
| user | cadena | nombre del usuario con el que se quiere hacer el log in | Sí |
| psw | cadena | contraseña del usuario | Sí |
Encabezados de la solicitud
| Nombre del encabezado | Descripción del encabezado | Obligatorio |
|---|---|---|
Cuerpo de la solicitud
No se requiere un cuerpo de solicitud para este método HTTP.
Parámetros de la respuesta
| Nombre del parámetro | Tipo de dato | Descripción del parámetro |
|---|---|---|
| tkn.val | cadena | Token de autenticación |
Códigos de estado de la respuesta
| Código de estado | Descripción del código de estado | Posibles razones |
|---|---|---|
| 200 | OK | La solicitud fue exitosa |
| 401 | Unauthorized | El usuario no está autenticado |
Ejemplo de consulta
http://ctincoming/CTNEAT/LOGIN/CTNEAT/1234
Ejemplo de respuesta
{ "val":"F7C9403161C67E8675AC1CE8C583CCA4BDF4C5A76408C433AA9284625FF5207D" }
LOG OUT
Esta función permite dar de baja el token de autenticación asociado al usuario, lo que impide que se utilice para acceder a las funciones de la API y garantiza la seguridad de la información. De este modo, se evita el acceso no autorizado a la API y se asegura la protección de los datos del usuario
URL
https://[server]/CTNEAT/LOGOUT/{tkn}
Método HTTP
PUT
Parámetros de la solicitud
| Nombre del parámetro | Tipo de dato | Descripción del parámetro | Obligatorio |
|---|---|---|---|
| tkn | cadena | Token de autenticación | Sí |
Encabezados de la solicitud
| Nombre del encabezado | Descripción del encabezado | Obligatorio |
|---|---|---|
Cuerpo de la solicitud
No se requiere un cuerpo de solicitud para este método HTTP.
Parámetros de la respuesta
| Nombre del parámetro | Tipo de dato | Descripción del parámetro | Formato |
|---|---|---|---|
| ErrorContent | JSON | Json con la descripción del resultado de la operación | Formato ErrorContent |
Códigos de estado de la respuesta
| Código de estado | Descripción del código de estado | Posibles razones |
|---|---|---|
| 200 | OK | La solicitud fue exitosa |
| 401 | Unauthorized | El usuario no está autenticado |
Ejemplo de consulta
http://ctincoming/CTNEAT/LOGOUT/F7C9403161C67E8675AC1CE8C583CCA4BDF4C5A76408C433AA9284625FF5207D
Ejemplo de respuesta
{ "Success":{ "faultcode":"none", "faultstring":"user logged out", "detail":"" } }