Manual de usuario - Jorge Iván Meza Martínez
Contents
1. el valor especificado anteriormente en el campo nombre del arreglo servicios Para el caso de ejemplo utilizado anteriormente el nombre del archivo ser a consulta_departamentos sd l Los archivos SQL pueden flexibilizarse a n mas utilizando etiquetas que corresponden con ciertas Cadenas reservadas de la forma nombre_etiqueta que ser n reemplazadas din micamente seg n la informaci n proporcionada por el cliente en el momento de ejecutarse en la base de datos Estas etiquetas son tiles para condicionar la sentencia SQL a las necesidades del usuario expresadas durante la solicitud de la informaci n Como pasos finales de configuraci n deber garantizarse que el usuario bajo el cual se ejecuta el servidor de p ginas tenga permisos de lectura para el directorio sql donde se almacenan las consultas SQL y y escritura para el directorio log donde se almacenan los registros de eventos sucedidos CLIENTE Por cada servicio u or gen de datos Ejemplo departamentos debe crearse un archivo de nombre libre y con la extensi n php que se encuentre basado en el archivo cliente php de la distribuci n y modificado seg n los par metros descritos a continuaci n La variable servicio hace referencia al servicio que se va a solicitar Su valor deber coincidir con el valor especificado de un campo nombre del arreglo servicios ubicado en el archivo config php del servidor de lo contrario se estar solicitando un servicio inexisten2. por el servicio servicios mencionado anteriormente Si el valor de listable es false no ser incluido en el listado de servicios disponibles sin embargo podr ser accedido por los clientes que lo soliciten expl citamente El arreglo de ip_ permitidas permite determinar cuales son las direcciones IP v lidas que podr n acceder al servicio Cualquier intento de conexi n que provenga de un cliente cuya direcci n IP no se encuentre en la lista ser desconectado inmediatamente impidi ndosele el acceso Para facilidad de la administraci n es posible no s lo especificar direcciones IP precisas Ejemplo 192 168 1 7 sino tambi n permitir especificar una secci n parcial de la direcci n para permitir rangos mayores de direcciones IP Por ejemplo si se permite el acceso al rango 190 6 54 todas las direcciones del segmento podr n acceder al l es decir podr n acceder las siguientes direcciones entre otras 190 6 54 2 190 6 54 100 190 6 54 250 Si se eligi el m todo de Consultas Gen ricas para un servicio espec fico ver campo funcion del arreglo servicios debe entonces especificarse tambi n una consulta SQL que se ejecutar en la base de datos y cuyo resultado ser el transmitido al cliente como resultado de la solicitud de informaci n Esta consulta debe almacenarse en un archivo de texto plano nombrado consulta_NOMBRE SERVICIO sql y deber ubicarse en la carpeta sql El nombre del servicio deber coincidir con
3. MANUAL DE USUARIO Webservice simple para la exportaci n r pida de informaci n proveniente de una base de datos Versi n 0 1 Jorge lv n Meza Mart nez lt jimezamQ gmail com gt INTRODUCCI N Esta aplicaci n permite transmitir f cilmente y por demanda cierta informaci n espec fica de una base de datos a trav s de un servicio web sin tener que permitir el acceso directo a la base de datos ni a la estructura de las tablas almacenadas en ella La aplicaci n permite definir consultas SQL que ser n ejecutadas internamente y su resultado ser enviado al usuario como una matriz de datos el usuario accede al sistema a trav s de un servicio web que puede ser restringido a ciertas direcciones IP desde las cuales es v lido y seguro consumir el servicio Tanto el cliente como el servidor est n desarrollados en PHP el servidor se debe ubicar en el servidor web donde se hospeda el proyecto or gen de los datos el cliente puede ser utilizado desde cualquier ubicaci n que sea permitida para el sistema y se ejecuta a trav s de la l nea de comando CLI command line interface REQUERIMIENTOS Para el servidor se requiere un servidor web con soporte para PHP desarrollado con la versi n 5 2 0 y para el motor de base de datos MySQL de igual manera se require que el servidor sea visible en t rminos de redes de las estaciones de trabajo que actuar n como clientes Se requiere que el cliente cuente con una distribuci n funcion
4. al de PHP con soporte CLI para la ejecuci n de scripts desde la l nea de comando INSTALACI N SERVIDOR Se deben copiar los siguientes directorios a una ubicaci n que dependa del rbol de documentos p blicos document root del servidor de p ginas del proyecto or gen de los datos index html entidades php config php doc lib log sql CLIENTE La instalaci n en del cliente del servicio web puede realizarse en cualquier directorio de la estaci n de trabajo en el deber n incluirse los siguientes archivos y directorios cliente php doc lib resultado CONFIGURACI N SERVIDOR Para configurar el servidor del servicio web edite el archivo config php de acuerdo a sus necesidades a partir de la siguiente informaci n El arreglo de servicios determinar cuales son los servicios o fuentes de datos consultables disponibles Agregue elementos a este arreglo como opciones desee publicar A continuaci n se describen los campos de cada entrada de informaci n de un servicio nombre nombre del servicio de esta manera se identificar al interior del sistema y a trav s de l ser solicitado por el cliente Ejemplo el servicio que lista los departamentos almacenados en la base de datos se llama departamentos Hay un servicio propio del mismo sistema llamado servicios cuya funci n es la de retornar al cliente un listado de los servicios activos que dispone el servidor actualmente descripcion es un texto lib
5. re en el cual se explica la finalidad del servicio Para el ejemplo de los servicios su descripci n podr a ser Obtiene un listado de los departamentos disponibles en la Plataforma Tecnol gica funci n corresponde con el nombre de la funci n de c digo PHP que se va a ejecutar para obtener procesar y enviar la informaci n resultante al cliente que la solicita El sistema dispone de dos formas de obtener y procesar esta informaci n la primera forma corresponde con la mencionada anteriormente la especificaci n de una funci n de c digo que se encargar de preparar la matriz de informaci n resultante Esta forma requiere de conocimientos en PHP y de la manipulaci n del archivo entidades php para agregar la funci n en l La segunda versi n es mas flexible y r pida de implementar requiere nicamente de la especificaci n de la consulta SQL para obtener la informaci n solicitada por el cliente la construcci n de la matriz de datos y su consecuente env o se realizan de manera autom tica Para elegir este m todo se debe asignar null al campo funci n correspondiente al servicio editado activo es un valior booleano true verdadero o false falso que indica si el servicio se encuentra o no disponible para ser consumido por el p blico Si el valor de activo es false no podr ser utilizado por los clientes listable es un valior booleano true verdadero o false falso que indica si el servicio ser o no enumerado
6. te La especificaci n del arreglo parametros es opcional y a trav s de l se determinan los par metros que van a ser transmitidos al servidor y que este a su vez utilizar para reemplazar las etiquetas encontradas en la consulta SQL Los ndices de los elementos del arreglo deber n coincidir con el nombre de las etiquetas y su valor ser el valor espec fico por el cual ser n reemplazadas Ejemplo La etiqueta edad ser reemplazada por el valor de la celda del arreglo cuyo ndice sea edad como podr a ser edad gt 30 En caso de que no se deseen especificar par metros su valor deber ser el de un arreglo vac o parametros array La variable fwebservice_url deber ser asignada a la direcci n or URL donde se encuentra el archivo entidades php EJECUCI N Para ejecutar la aplicaci n cliente abra una consola de comandos s mbolo del sistema y ejecute el siguiente comando php cliente php En el caso en que no cuente con la ubicaci n del int rprete CLI de PHP en la variable de ambiente PATH SPATHS escriba la ruta completa donde este se ubica De igual manera si no se encuentra directamente en el directorio donde se encuentra el archivo cliente php especifique la ruta necesaria para llegar a l ruta a php ruta a cliente php para Linux Xrutalalphp 1rutalalcliente php para Windows Si el hecho de consumir el servicio genera alg n tipo de error en el servidor este se mostrado inmediatamen
7. te en la consola y su ejecuci n es abortada En caso de que la ejecuci n sea exitosa la informaci n enviada por el servidor como respuesta a la consulta solicitada es almacenada en el archivo NOMBRE SERVICIO csv bajo el directorio resultado Tenga en cuenta que cada ejecuci n sobreescribir los archivos CSV resultantes as que considere mover los archivos obtenidos durante una ejecuci n de la aplicaci n antes de realizar el siguiente llamado RESTRICCIONES La aplicaci n es compatible con el motor de base de datos MySQL nicamente y requiere que la aplicaci n principal de la cual toma la informaci n de conexi n a la base de datos se encuentre desarrollada en Codelgniter http www codeigniter com y se encuentre ubicada bajo el directorio pt encontrado un nivel jer rquico mas arriba del directorio de este sistema Estas restricciones s lo existen debido a que eran las condiciones necesarias para cumplir con los requisitos que generaron la necesidad inicial de este software sin embargo son f cilmente solventables si es necesario aumentar su funcionalidad a otros ambientes LICENCIA Esta aplicaci n se distribuye tal cual AS S bajo la licencia GPL no incluye ning n tipo de garant a responsabilidad ni obligaci n por parte del autor debe usarse bajo su propio riesgo Consulte el siguiente enlace para obtener informaci n adicional del licenciamiento http www gnu org licenses gpl html
Download Pdf Manuals
Related Search