Home
Generalidades Collapse menú
Descripción de operaciones Collapse menú
Escenarios Collapse menú
Adobe PDF

Descargar PDF
    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:
    1. Inglés
    2. Españo
    3. 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.
    APPLICATIONNAME Texto No Nombre de la aplicación externa que consume el servicio.
    FOREIGN Texto No No es obligatorio siempre y cuando el nombre de la aplicación no se envíe.
    Las posibles opciones son:
    1. True (si aplicación es foránea)
    2. False (Si aplicación no es foránea)


    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 para inicio de sesión con CMDB:

    [
    {
        "Field": "username",
        "Value": "USUARIO_CMDB"
    },
    {
        "Field": "password",
        "Value": "CONTRASEÑA_DEL_USUARIO"
    }
]


    Ejemplo para inicio de sesión con aplicación externa:

    [
    {
        "Field": "username",
        "Value": "USUARIO_CMDB"
    },
    {
        "Field": "password",
        "Value": "CONTRASEÑA_DEL_USUARIO"
    },
    {
        "Field": "applicationname",
        "Value": "Nombre de aplicación externa"
    },
    {
        "Field": "foreign",
        "Value": "true"
    }
]


    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 InvalidConsoleId
    400 BadRequest InvalidConsoleVersion
    400 BadRequest InvalidDeviceImei
    400 BadRequest InvalidDeviceBrandId
    400 BadRequest InvalidDeviceName
    400 BadRequest InvalidLangId
    400 BadRequest DeviceNameIsRequired
    400 BadRequest InvalidForeignValue
    400 BadRequest InvalidApplicationName
    500 InternalServerError FailureOnLogin