SISO ---- por Emilio Rojas. 11 12 2014 ---- Este es un manual básico para el uso de este sistema. PARAM, VAL ---- Cuando se realizan pedidos al servidor, pueden enviarse argumentos para que el servidor realize con ellos diferentes acciones, en muchas ocaciones una pagina es inoperable si no se le adjuntan estos argumentos. param se refiere al nombre del argumento(parametro) val se refiere al valor del argumento indicado para efectos de este manual, se utilizaran las palabras param, parametro, val, value, valor GET, POST ---- Este sistema trabaja con dos tipos de pedidos, get y post los pedidos get son aquellos en los cuales se solicita informacion al servidor, sin que este guarde ningun param Los pedidos post, son aquellos en los cuales el servidor almacena los valores de los parametros suministrados. Independientemente del tipo de pedido que se haga, el servidor siempre da una respuesta JSON, indicando el estado del pedido asi como la informacion que haya sido solicitada en caso de un pedido get. HTTP ---- REMOTE ADDRESS ---- Es la direccion ip que da la respuesta REQUEST URL ---- Es la pagina que se ha accedido REQUEST METHOD ---- Es el metodo utilizado, GET, POST, ... STATUS CODE ---- Es un codigo que denota el estado del servidor algunos casos comunes son 200 OK, 404 no encontrado, 500 error interno, ... REQUEST HEADERS ---- Es la informacion que el cliente envia al servidor, por ejemplo ip, locacion, buscador utilizado, tambien aqui se encuentran los parametros con sus valores que envie el cliente RESPONSE HEADERS ---- Es la informacion que el servidor devuele al cliente, por ejemplo el tipo de contenido que se devuelve, fecha, ... CONTENIDO GLOBAL DE LAS RESPUESTAS ---- Para cada pedido existen respuestas especificas, sin embargo en todo caso se devuelve una respuesta JSON con la siguiente informacioó NOMBRE 'status' VALOR boolean DESCR true si se ha podido procesar correctamente el pedido NOMBRE 'data' VALOR objeto DESCR representa la informacion que se ha solicitado, o bien confirmacion del buen manejo de los datos enviados NOMBRE 'error' VALOR string, false DESCR en caso de error, da un mensaje de error, si no hay error el valor se asigna false o bien un string vacio("") CONTENIDO GLOBAL DE LAS PETICIONES ---- Este contenido se refiere a los parametros GET o POST. El servidor identifica que tipo de pedido se realiza. Para cada pedido se solicita informacion especifica, sin embargo en todo caso son mandatorios los siguientes parametros PARAM 'apiKey' VAL string otorgado al usuario DESCR Un api key es un string otorgado a un usuario de este sistema para que pueda utilizarlo. Este es un elemento indispensable para que cualquier pedido pueda completarse de manera efectiva PARAM 'user' VAL nombre de usuario DESCR Se utiliza para verificar la identidad del solicitante no hay ningun pedido que no requiera este parametro PARAM 'pass' VAL contraseña de usuario DESCR Para chequeo de la identidad PARAM 'action' VAL string DESCR Se refiere a la accion que se solicita, estas acciones están descritas a continuación y en cada una se idican los paraetros que requieren para utilizarse adecuadamente HTTP REQUESTS ---- req 'getLogin' DESCR indica si cierto usuario esta logueado, en general no es una acción necesaria RESPUESTA NOMBRE logged VALOR boolean req 'getEvents' DESCR devuelve un arreglo de objetos para la creación de eventos RESPUESTA NOMBRE Evento[] NOMBRE id NOMBRE title NOMBRE description NOMBRE location NOMBRE startTimestamp req 'postCreateAccount' DESCR crea una nueva cuenta y devuelve una respuesta RESPUESTA NOMBRE created NOMBRE message req 'postCreateEvent' DESCR crea un nuevo evento y devuelve una respuesta RESPUESTA NOMBRE created NOMBRE message