Detalles de la petición:
-
URI: api/v8.1/user/login
-
Tipo: POST
-
Encabezados requeridos:
- Content-Type: application/json
Parámetros:
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| USERNAME | Texto | Si | Usuario que iniciará sesión. |
| PASSWORD | Texto | Si | Contraseña correspondiente al usuario. |
| LANGUAGEID | Número | No | Idioma con que se registrará la sesión. Las posibles opciones son: 1. Inglés 2. Españo 3. Portugués Si no se provee, por defecto se registra en inglés. |
Cuerpo de la petición:
La petición consiste de un arreglo json de tipo field-value con los posibles parámetros según se requiera. Ejemplo:
[
{
"Field": "username",
"Value": "USUARIO_ASDK"
},
{
"Field": "password",
"Value": "CONTRASEÑA_DEL_USUARIO"
}
]
Respuesta:
Como respuesta se obtiene un objeto json, con la siguiente información:
[
{
"Field": "userId",
"Value": "####"
},
{
"Field": "sessionId",
"Value": ""###AAABBBCCC###"
},
{
"Field": "result",
"Value": "True"
}
]
Mensajes de error:
| Código | Estado HTTP | Mensaje de error |
|---|---|---|
| 400 | BadRequest | InvalidUserName |
| 400 | BadRequest | InvalidPassword |
| 400 | BadRequest | InvalidLangId |
| 401 | Unauthorized | InvalidUserData |
| 500 | InternalServerError | FailureOnLogin |