¿Cómo establecer comunicación con el Agente?
GetAuth (datajson, controlkey, iapp, random) : json

Descripción

Esta función es la encargada de loguear a un usuario en el Agente y retornar un código único para la sesión del usuario (keyAgente). Ésta es la primera función que se debe ejecutar para establecer comunicación con el Agente.

Resultado

Retorna los datos que identifican al usuario logueado en el Agente.
Seguridad
Aplica todas las configuraciones de seguridad de datos y de seguridad de acciones de ContaPyme / AgroWin.
Compatibilidad de la API
Función disponible desde ContaPyme/AgroWin Versión 4 - Release 7.

Petición

Requisitos
Ninguno
Parámetros
Nombre parámetro Tipo Descripción Ejemplo
dataJSON JSON

Json que contiene en su interior la siguiente estructura.

email: Correo electrónico con el cual se encuentra registrado el usuario en la aplicación ContaPyme/AgroWin. (requerido)

password: Contraseña del usuario asignada en el sistema. Para enviar este parámetro en el llamado de la función se debe convertir a mayúscula y encriptarlo en MD5. (requerido)

idmaquina: Código que se genera por cada equipo, se debe generar con las características del equipo desde el cual se está accediendo. El idmaquina permite restringir el acceso de varios usuarios con los mismos datos de logueo. (email y password). (opcional)

{ "email": "pperez@gmail.com ", "password": "c4ca4238a0b923820dcc509a6f75849b", "idmaquina": "537.22_136301143299" }
controlkey Varchar Corresponde al keyagente obtenido en el logueo (requerido). "564654"
iapp Varchar Código que identifica a la aplicación que interactúa con el Agente (requerido) "1068"
random Varchar Cadena aleatoria que se crea en el lado del cliente, esto con el fin de que las peticiones no sean cacheadas por el navegador Internet Explorer (para aplicaciones web). (Opcional). "54654"
Ejemplo de la ejecución en JavaScript
//Escriba a continuación la URL donde se encuentra su Agente de servicios web de ContaPyme. var URLUbicacion = 'http://local.insoft.co:9000' var URLFuncion = '/datasnap/rest/TBasicoGeneral/"GetAuth"/'; //Se construye la URL completa la cual es la concatenación de la ubicación y la función var URL = URLUbicacion + URLFuncion; //Invocamos la función que retorna controlKey para modo aprendizaje var controlkey = getControlKey(URLUbicacion); //1001 es el iapp configurado para agente de servicios web de ContaPyme. var iapp = "1001"; //dataJSON: parámetros de entrada para la función var dataJSON = {    "email": "pperez@gmail.com ",    "password": "c4ca4238a0b923820dcc509a6f75849b",    "idmaquina": "537.22_136301143299" }; //Se arma los 4 parámetros de entrada de la funcion var JSONSend ={ "_parameters" : [ JSON.stringify(dataJSON), controlkey, iapp ,"0" ] }; //se constuye objeto para realizar la petición desde JavaScript var xhr = new XMLHttpRequest(); //Se inicializa la solicitud enviando el verbo y la URL a invocar xhr.open("POST",URL); //Se define el evento que se disparará cuando se resuelva la petición xhr.onreadystatechange = function() { //se verifica que la petición se hubiese terminado if (xhr.readyState == 4 && xhr.status == 200) { //se envia la respuesta del servidor para que se imprima imprimirRespuesta(xhr.responseText) } }; //Envía la solicitud adjuntando el JSONSend que contiene los 4 parametros de la función xhr.send(JSON.stringify(JSONSend));
EJECUTAR CODIGO
Ver otros ejemplos en: PHP , JAVA , C# , Visual Basic.net , Visual Basic 6 , Delphi.
Ver documentación de la petición por GET.

Respuesta

JSONIr arriba
{ "result": [ { "encabezado": { "resultado": "true", "imensaje": "", "mensaje": "", "tiempo": "219" }, "respuesta": { "datos": { "keyagente": "28533BCD97", "version": "4", "release": "7", "actualizacion": "1" } } } ] }
Descripción del JSON Ir arriba
Nombre parámetro Tipo Descripción
encabezado JSON

Json que contiene en su interior los siguientes datos:

resultado (varchar): Retorna true siempre que la petición se ejecute satisfactoriamente.
imensaje (varchar): Código del mensaje de eventualidad o error en caso de presentarse.
mensaje (varchar): Mensaje de eventualidad o error en caso de presentarse.
tiempo (varchar): Tiempo que se tardó el Agente en resolver la petición, este tiempo está dado en milisegundos.

respuesta JSON

Json que contiene en su interior el objeto “datos” que se describe a continuación:

keyagente (varchar): Identificador único que se asigna a cada usuario cuando se loguea en el Agente.
Este identificador se debe utilizar en cada petición que se haga al agente después del logueo, es lo que corresponde al “controlkey”

versión (varchar): Número de versión en la que se encuentra el sistema ContaPyme / AgroWin.

release (varchar): Número de release en el que se encuentra el sistema ContaPyme / AgroWin.

actualizacion (varchar): Número de la actualización en la que se encuentra el sistema ContaPyme / AgroWin.

EventualidadesIr arriba
Para esta función se pueden presentar las siguientes eventualidades o errores: Un ejemplo del JSON que retorna la función cuando se genera una eventualidad es el siguiente:

{ "result":[{ "encabezado":{"resultado":"false","imensaje":"40","mensaje":"Usuario no logueado."}, "respuesta":{"datos":""} }] }

©2016 InSoft Todos los derechos reservados.