ES
Español
English
Português
    Inicio de Sesión

    Manejo de Sesión

    En esta sección se describen las operaciones relacionadas con el manejo de sesiones (autenticación de usuarios, renovación de token y cierre de sesión).

    Inicio de Sesión

    Detalles de la petición

    • URI: api/v8.6/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:
    Inglés
    Español
    Portugués
    Si no se provee, por defecto se registra en inglés.
    CONSOLEID Número No  
    CONSOLEVERSION Texto No Versión de la consola desde la que se inicia sesión..
    DEVICEIMEI Texto No IMEI del dispositivo móvil desde el que se inicia sesión.
    DEVICEBRANDID Número No
    Marca del dispositivo desde el que se inicia sesión. Las posibles opciones son:
    1. Android
    2. iOS
    DEVICENAME Texto No Nombre del dispositivo móvil desde el que se inicia sesión.
    DEVICEREGISTRATIONID Texto No RegistrationId del dispositivo móvil, utilizado para mensajes push.

    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 BadRquest InvalidUserName
    400 BadRquest InvalidPassword
    400 BadRquest InvalidConsoleId
    400 BadRequest InvalidConsoleVersion
    400 BadRequest InvalidDeviceImei
    400 BadRequest InvalidDeviceBrandId
    400 BadRquest InvalidDeviceName
    400 BadRquest InvalidLangId
    400 BadRquest DeviceNameIsRequire