Mca023 PHP, SERVICIOS WEB. Sé diferente, intégrate. Autor: Orlando Gutiérrez Fecha: 11 / 03 / 2013

Transcripción

2 INDICE Pag. 4 Lección 1 Historia de la tecnología de Integración de Aplicaciones Pag. 5 Pag. 6 Pag. 7 Pag. 9 Pag. 11 Pag. 12 Pag. 12 Pag. 13 Pag. 14 Pag. 14 Pag. 16 Lección 2 Independencia de la Plataforma y la Tecnología Lección 3 Introducción a los Servicios WEB Lección 4 Conceptos Servicios WEB Lección 5 Protocolo de acceso a objetos SOAP Lección 6 Lenguaje de los servicios WEB, WSDL Lección 7 Registro de servicios WEB, UDDI Lección 8 Soporte para servicios WEB en PHP Lección 9 Proyecto NuSOAP SourceForge.Net Lección 10 Librería NuSOAP Lección 11 Clases NuSOAP Lección 12 Consumiendo servicios WEB Pag. 19 Pag. 21 Pag. 25 Pag. 25 Pag. 26 Pag. 26 Lección 13 Desarrollo de un cliente en PHP empleando las clases de NuSOAP Lección 14 Servidores SOAP en NuSOAP Lección 15 Programación en NuSOAP Protocolo SOAP Lección 16 "Parsing" mensajes SOAP con NuSOAP Lección 17 Desarrollo de un servicio WEB con PHP Lección 18 Soporte en PHP 5.x para SOAP Pag. 27 Lección 19 Funciones SOAP PHP 5.x Pag. 28 Lección 20 Clases SOAP PHP 5.x Pag. 29 Pag. 30 Pag. 32 Lección 21 Clase SOAPClient Lección 22 Clase SOAPServer Lección 23 Clase SOAPFault Pag. 33 Lección 24 Consumiendo un servicio WEB desarrollado en PHP en otro lenguaje de Programación soportando servicios WEB Todos los derechos reservados, prohibida la reproducción, Instituto Gala de Venezuela 2

3 LECCION 1 Historia de la tecnología de Integración de Aplicaciones Muchos hitos se han desarrollado en las tecnologías de integración de aplicaciones; algunos de los cuales se indican a continuación: EDI (ELECTRONIC DATA INTERCHANGE): El intercambio electrónico de datos es la transmisión estructurada de datos entre organizaciones por medios electrónicos. Se usa para transferir documentos electrónicos o datos de negocios de un sistema computacional a otro. El intercambio electrónico de datos puede realizarse en distintos formatos: EDIFACT, XML, ANSI ASC X12, TXT, etc. EDIFACT es un estándar de la Organización de las Naciones Unidas para el intercambio de documentos comerciales en el ámbito mundial. Existiendo subestándares para cada entorno de negocio (distribución, automoción, transporte, aduanero, etc) o para cada país. Así, por ejemplo, AECOC regula el estándar EDI del sector de distribución. Para el intercambio de este tipo de información se suelen utilizar las redes de valor agregado. Además del intercambio de la información, estas redes permiten su registro. EDI son las siglas de Electronic Data Interchange, intercambio electrónico de datos. El sistema EDI permite el intercambio (envío y recepción) de documentos comerciales por vía telemática. E-COMMERCE: El comercio electrónico, también conocido como e-commerce (electronic commerce en inglés), consiste en la compra y venta de productos o de servicios a través de medios electrónicos, tales como Internet y otras redes informáticas. Originalmente el término se aplicaba a la realización de transacciones mediante medios electrónicos tales como el Intercambio electrónico de datos, sin embargo con el advenimiento de la Internet y la World Wide Web a mediados de los años 90 comenzó a referirse principalmente a la venta de bienes y servicios a través de Internet, usando como forma de pago medios electrónicos, tales como las tarjetas de crédito. B2C (BUSINESS TO CUSTOMER): B2C es la abreviatura de la expresión Business-to-Consumer («del negocio al consumidor», en inglés). B2C se refiere a la estrategia que desarrollan las empresas comerciales para llegar directamente al cliente o consumidor final. B2B (BUSINESS TO BUSINESS): Business-to-business es la transmisión de información referente a transacciones comerciales electrónicamente, normalmente utilizando tecnología como la Electronic Data Interchange (EDI), presentada a finales de los años 1970 para enviar electrónicamente documentos tales como pedidos de compra o facturas. Más tarde pasó a incluir actividades que serían más precisamente denominadas "Comercio en la red", como la compra de bienes y servicios a través de la Web vía servidores seguros HTTPS, un protocolo de servidor especial que cifra la realización confidencial de pedidos para la protección de los consumidores y los datos de la organización) empleándose servicios de pago electrónico como autorizaciones para tarjeta de crédito o monederos electrónicos. En la siguiente figura se resume la evolución de las tecnologías de integración de aplicaciones. Todos los derechos reservados, prohibida la reproducción, Instituto Gala de Venezuela 3

4 LECCION 2 Independencia de la Plataforma y la Tecnología Los Servicios Web surgieron ante una necesidad de estandarizar la comunicación entre distintas plataformas (PC, Mainframe, Mac, estaciones linux, etc.), lenguajes de programación (PHP, C#, Java, etc.) y distintos sistemas de operación (Linux, Windows, MacOs, etc). Anteriormente se habían realizado intentos de crear estándares pero fracasaron o no tuvieron el suficiente éxito, algunos de ellos son DCOM y CORBA, por ser dependientes de la implementación del vendedor DCOM - Microsoft, y CORBA - ORB (a pesar que CORBA de múltiples vendedores pueden operar entre si, hay ciertas limitaciones para aplicaciones de niveles más altos en los cuales se necesite seguridad o administración de transacciones). Otro gran problema es que se hacía uso de RPC (Remote Procedure Call) para realizar la comunicación entre diferentes nodos. Esto, además de presentar ciertos problemas de seguridad, tiene la desventaja de que su implementación en un ambiente como es Internet, es casi imposible (muchos firewalls bloquean este tipo de mensajes, lo que hace prácticamente imposible a dos computadoras conectadas por Internet comunicarse). Los servicios web surgieron para finalmente poder lograr la tan esperada comunicación entre diferentes plataformas. En la actualidad muchos sistemas de legado están pasando a ser servicios web. Es por esto que en 1999 se comenzó a plantear un nuevo estándar, el cual terminaría utilizando XML, SOAP, WSDL, y UDDI. A pesar de mucho limitar el uso de los servicios web services al protocolo HTTP, los servicios web no fueron pensados para un protocolo en particular, es decir, nada impide utilizar SOAP sobre algún otro protocolo de Internet (SMTP, FTP, etc.). Se utiliza principalmente HTTP por ser un protocolo ampliamente difundido y que se encuentra menos restringido por firewalls (generalmente se bloquean puertos como el FTP, pero el HTTP es muy probable que no esté bloqueado). Todos los derechos reservados, prohibida la reproducción, Instituto Gala de Venezuela 4

5 LECCION 3 Introducción a los Servicios WEB La programación en Internet evoluciona rápidamente desde las aplicaciones WEB más comunes que permiten a través de un navegador mostrar interfaces de usuario con el contenido deseado hasta la próxima generación de aplicaciones que permiten la integración de negocios, organizaciones, aplicaciones, servicios, y dispositivos entre otros. La tecnología que permite realizar esta integración, se llama servicios WEB XML inteligentes, permitiendo acceder a los recursos WEB como servicios de programación. Los modelos de desarrollo de servicios web son escalable y extensibles y se basan en estándares de Internet abiertos y públicos (open source) como HTTP, XML, SOAP, WSDL. Por lo tanto un servicio WEB puede ser utilizado y accedido (consumido en la terminología de servicios WEB) en cualquier plataforma donde Internet se encuentre disponible. Un servicio web puede verse como un sistema software diseñado para soportar la interoperabilidad programa - programa a través de una red. Ofrecen una interfaz descripta en un formato que puede ser procesado cualquier porograma (específicamente WSDL). Otros sistemas interactúan con el servicio web utilizando mensajes SOAP los cuales se encuentran establecidos previamente. Entonces se puede decir que un servicio web es una comunicación por medio de mensajes SOAP (son mensajes especiales) entre diferentes programas a través de una red. Qué es XML, SOAP, WSDL, UDDI? Para conocer cómo se realiza el intercambio de mensajes en los servicios web se debemos primero saber cuales son los elementos fundamentales que lo componen. Estos son XML, SOAP, WSDL, y UDDI. XML - extensible Markup Language: Es un subconjunto simplificado del SGML el cual fue diseñado principalmente para documentos Web. Deja a los diseñadores crear sus propias etiquetas o "tags" (Ej: <libro>), habilitando la definición, transmisión, validación, y la interpretación de datos entre aplicaciones y entre organizaciones. Es importante aclarar que el HTML y el XML tienen funciones diferentes. El HTML tiene por objeto mostrar información, mientras que el XML se ocupa de la información propiamente dicha (el contenido). Este concepto es importante tenerlo en cuenta, porque muchas personas al escuchar sobre XML piensan que es el sucesor de HTML. Ejemplo de un documento XML sobre información de carros: <?xml version="1.0" encoding="utf-8"?> <vehiculos> <carro> <marca>toyota</marca> <modelo>corolla</modelo> <fechacompra>2002</fechacompra> </carro> <carro> <marca>honda</marca> <modelo>civic</modelo> <fechacompra>2003</fechacompra> </carro> Todos los derechos reservados, prohibida la reproducción, Instituto Gala de Venezuela 5

6 </vehiculos> Muchos documentos en Internet están en formato XML. Se resumen brevemente las secciones del mismo: <?xml version="1.0" encoding="utf-8"?> Todo documento XML debe comenzar indicando que es un documento XML, la versión del mismo y su codificación. Es por eso que se utiliza el tag <?xml...?>. Todos los elementos a partir de alli son definidos por el usuario. <vehiculos> Luego se indica un tag raiz (<vehiculos>) el cual contendrá a los demás elementos. Es como en HTML el tag <HTML>.. </HTML>, que dentro de él se encuentran los demás tags. Se lo conoce generalmente como root del documento. <carro> Luego se define un tag <carro> el cual contendrá un carro en particular (en este caso solo incorpore 3 características de un carro: marca, modelo, y fecha de compra). <marca>toyota</marca> <modelo>corolla</modelo> <fechacompra>2002</fechacompra> Se definen 3 tags (marca, modelo, y fechacompra), los cuales contienen los datos para un carro en particular. <vehiculos> <carro> <marca>..</marca> <modelo>..</modelo> <fechacompra>..</fechacompra> </carro> </vehiculos> En el documento se puede apreciar que todos los tags que son abiertos <marca> deben ser cerrados </marca>. Esto es una exigencia del XML. Se pueden anidar tags <carro><marca></marca>..</carro>. Marca está dentro del tag carro. XML provee muchas otras posibilidades como puede ser que las etiquetas tengan atributos (<carro color="rojo">..</coche>). LECCION 4 Conceptos Servicios WEB Qué es un servicio Web? Es un servicio ofrecido a través de la Web. En un escenario típico se servicios Web se siguen los siguientes pasos: Todos los derechos reservados, prohibida la reproducción, Instituto Gala de Venezuela 6

7 Una aplicación cliente (de negocio) solicita un requerimiento a un servicio a través de un URL empleando el protocolo SOAP sobre HTTP El servicio recibe el requerimiento, lo procesa y envía la respuesta Los servicios web pueden verse como los habilitadores building blocks para implementar una arquitectura de computación distribuida en Internet. Adicionalmente los servicios Web trabajan bajo estándares abiertos como XML, de allí su gran potencial en las áreas de integración de aplicaciones. Las aplicaciones son construidas invocando varios servicios web, servidos desde varias fuentes, para trabajar de una manera colaborativa independientemente de donde residan o de cómo fueron implementados. Los servicios web exportan su funcionalidad a través de un protocolo web estándar, por lo general emplean SOAP (Simple Object Access Protocol). Los servicios web proveen un mecanismo para describir sus interfaces lo suficientemente detallado y preciso de modo que los clientes pueden comunicarse efectivamente con ellos para solicitar un servicio. La descripción de las interfaces de los servicios Web se realiza a través de un documento XML llamado documento WSDL (Web Services Description Language). Adicionalmente, los servicios Web son registrados de modo que los usuarios puedan fácilmente encontrarlos, esto se realiza a través de un UDDI Universal Discovery Description and Integration o empleando ebxml. Componentes de un servicio web Un servicio web es un servicio de software, el cual es: publicado en la web a través de SOAP descrito con un documento XML llamado WSDL registrado en un UDDI En un nivel de detalle de implementación, un servicio web contiene un conjunto de: Especificaciones de puertos (Port Types) Definiciones de esquemas XML Definiciones de mensajes Operaciones Bindings (enlaces) que proveen los detalles de comunicación y protocolos. Servicios Web vs. Aplicaciones Web Los servicios web son aplicaciones distribuidas, construidos con componentes ejecutándose del lado del servidor similar a los sitios web comunes. Sin embargo, se diferencian de las aplicaciones web en el hecho de no poseer interfaces con el usuario GUI y no ser diseñadas para mostrar directamente en los navegadores. Los servicios web es mejor interpretarlos como componentes de software reutilizables. Los servicios web se encuentran diseñados para ser consumidos por otras aplicaciones como: aplicaciones clientes tradicionales aplicaciones web otros servicios web Todos los derechos reservados, prohibida la reproducción, Instituto Gala de Venezuela 7

8 Arquitectura de los servicios Web La arquitectura de los servicios web posee tres características principales: Una capa de invocación del servicio ( consumer ) Una capa para el manejo del flujo entre el servicio y el proceso Una capa de funcionalidad del servicio Beneficios de los servicios Web El desarrollo de software industrial se encuentra migrando a una arquitectura basada en servicios web debido a las múltiples ventajas que ofrece sobre la arquitectura tradicional de desarrollo. Una de estas ventajas es que cualquiera de las capas puede ser cambiada independientemente de las otras y el grupo de desarrollo responsable de desarrollar cada una de las capas no requiere conocer los detalles de las otras capas. En los servicios web se separa la funcionalidad del servicio de la funcionalidad del cliente: Permitiendo compartir y reutilizar la funcionalidad entre varias aplicaciones Ofreciendo transparencia en las aplicaciones cliente, no requieren conocer cómo fue implementado el servicio. Por ejemplo Microsoft.Net o Java 2 Enterprise Edition (J2EE) o Enterprise Java Beans (EJB) Permite la migración de la funcionalidad del servicio sin necesidad de cambiar o realizar pruebas en las aplicaciones clientes. Otro de los beneficios de adoptar una arquitectura basada en servicios web es la portabilidad de la plataforma tanto en localidad como el tipo de invocación de los servicios. LECCION 5 Protocolo de acceso a objetos SOAP SOAP es el acrónimo, abreviatura de Simple Object Access Protocol en inglés. Es un protocolo que permite la comunicación entre aplicaciones a través de mensajes por medio de Internet. Es independiente de la plataforma, y del lenguaje. Está basado en XML y es la base principal de los servicios. Los mensajes SOAP son documentos XML propiamente dichos. La estructura básica del protocolo se resume con el siguiente ejemplo: <?xml version="1.0"?> <soap:envelope xmlns:soap=" Soap:encodingStyle=" <soap:header>... </soap:header> <soap:body>... <soap:fault>... Todos los derechos reservados, prohibida la reproducción, Instituto Gala de Venezuela 8

9 </soap:fault> </soap:body> </soap:envelope> A continuación se detalla cada parte del documento: <?xml version="1.0"?> En esta línea SOAP se indica es un documento XML, y como tal, debe comenzar con el tag <?xml.?> y la versión correspondiente. <soap:envelope Aquí se indica que comienza el envelope (sobre) del mensaje xmlns:soap = " Un mensaje SOAP debe contener siempre un elemento envelope asociado con el namespace (espacio de nombres) Soap:encodingStyle=" En esta línea se indican donde se encuentran definidos los tipos de datos utilizados en el documento. <soap:header> Esta línea indica el comienzo del Header (encabezado). En esta sección se incluye información específica del mensaje, como puede ser la autenticación. Esta sección es opcional. </soap:header> Como todo documento XML los tags abiertos, deben ser cerrados, esta línea indica la finalización del Header (encabezado). <soap:body> Aquí comienza el cuerpo del mensaje, en esta sección se incorpora toda la información necesaria para el nodo final. Por ejemplo, los parámetros para la ejecución, o la respuesta a una petición. <soap:fault> Cualquier tipo de fallo que se produzca será notificado en esta sección. La cual está contenida dentro del cuerpo del mensaje. </soap:fault> Cierre de la sección Fault. </soap:body> Indica el final del cuerpo del mensaje. </soap:envelope> Fin del mensaje SOAP. Se mencionan algunas características de seguridad: Todos los derechos reservados, prohibida la reproducción, Instituto Gala de Venezuela 9

10 Se pueden obtener notificaciones a través del header, de seguridad en servicios web, WS Security Existen tokens especiales de seguridad Los servicios web pueden implementar tres mecanismos de seguridad: ** Propagación segura de tokens ** Integridad en los mensajes ** Confidencialidad en los mensajes LECCION 6 Lenguaje de los servicios WEB, WSDL WSDL es la abreviatura, acrónimo, en ingles de Web Services Design Language. Es un protocolo basado en XML que describe los accesos al servicio. Se puede decir que es el manual de operación del servicio web, porque nos indica cuales son las interfaces que provee el Servicio web y los tipos de datos necesarios para la utilización del mismo. A continuación se muestra un documento WSDL: <?xml version="1.0"> <definitions> <types>... </types> <message>... </message> <porttype>... </porttype> <binding>... </binding> </definitions> A continuación se explica el documento Explicación del código anterior: <?xml version="1.0"> Este es otro documento XML, es por esto que debe comenzar con el tag <?xml..?> <definitions> <types> </types> <message> </message> <porttype> </porttype> Comienzo del documento, este tag agrupa a todos los demás. Se definen los tipos de datos utilizados en el servicio web. Fin de la definición de tipos. Se definen los métodos y parámetros para realizar la operación. Cada message puede consistir en una o más partes (parámetros). Fin de la definición de los parámetros. Esta sección es la más importante, ya que se definen las operaciones que pueden ser realizadas, y los mensajes que involucran (por ejemplo el mensaje de petición y el de respuesta). Fin de la definición de las operaciones y mensajes. Todos los derechos reservados, prohibida la reproducción, Instituto Gala de Venezuela 10

11 <binding> </binding> </definitions> Se definen el formato del mensaje y detalles del protocolo para cada porttype. Fin de la definición del formato del mensaje y detalles del protocolo para cada PortType. Fin del documento WSDL LECCION 7 Registro de servicios WEB, UDDI UDDI es el acrónimo, abreviatura en ingles de - Universal Discovery Description and Integration Es un modelo de directorios para los servicios web. Es una especificación para mantener directorios estandarizados de información acerca de los servicios web, sus capacidades, ubicación, y requerimientos en un formato reconocido universalmente. UDDI utiliza WSDL para describir las interfaces de los servicios web. Es un lugar donde se puede buscar cuales son los Servicios web disponibles, una especie de directorio en el cual se encuentran los servicios web publicados y se pueden publicar los servicios web desarrollados. En los siguientes enlaces se encuentran ejemplos de UDDI LECCION 8 Soporte para servicios WEB en PHP Existen cuatro componentes para la implementación de servicios web en PHP: OAuth, SCA, SOAP y XML-RPC. OAuth Es una extensión de PHP. Esta extensión provee un cliente y un servicio OAuth. OAuth es un protocolo de autorización basado en HTTP el cual permite a las aplicaciones garantizar el acceso a datos sin tener alojado un nombre de usuario y contraseña. SCA SCA es una extensión experimental, por lo tanto no se recomienda utilizar en versiones profesionales de desarrollo. SCA para PHP posibilita a un programador de PHP para escribir componentes reusables, que pueden ser invocados de varias formas, con una interfaz idéntica y con un mínimo de preocupación. Por ahora, los componentes se pueden llamar unos a otros localmente o mediante servicios web, pero en el futuro se espera que sean posibles otras formas. Proporciona al programador una manera de realizar esto, la cual parecerá tan natural como sea posible en PHP. Los componentes SCA usan anotaciones estilo phpdocumentor ( para declarar dependencias sobre otros componentes SCA o servicios Web. El tiempo de ejecución de SCA para PHP resuelve estas dependiencias en tiempo de ejecución en nombre de los componentes, y así permite que el programador de PHP se centre en la lógica de negocio en vez de ubicar y obtener referencias a dependencias. El modelo de programación de SCA para PHP se puede ampliar para admitir varios tipos de servicios, como REST y Atompub. Sin embargo, los servicios web (más exactamente, definidos con WSDL, servicios SOAP/HTTP), son los únicos tipos actualmente especificados. Los componentes también usan anotaciones para definir la interfaz que exponen como servicio. El tiempo de ejecución de SCA para PHP automáticamente generará WSDL desde estas anotaciones, por lo que un componente SCA se expone con facilidad como un servicio web. Estas anotaciones son una extensión natural de las Todos los derechos reservados, prohibida la reproducción, Instituto Gala de Venezuela 11

12 proporcionadas por phpdocumentor. Implementar un servicio web puede ser tan simple como colocar un componente de PHP bajo la raíz de documentos de un servidor web. Los componentes también utilizan anotaciones para especificar estructuras de datos (expresadas usandos tipos complejos de esquemas XML) que son luego manejadas usando Objetos de Datos de Servicio (SDOs). Un script de PHP que no es un componente SCA y que no contiene anotaciones puede usar los servicios de un componente SCA. Un script o componente de PHP puede realizar llamadas a un servicio web que no sea un componente SCA, pero usando el mismo sistema de llamadas o anotaciones para obtener una referencia. SOAP La extensión SOAP se puede utilizar para escribir servidores y clientes SOAP. Admite los subconjuntos de especificaciones» SOAP 1.1,» SOAP 1.2 y» WSDL 1.1. Se recomienda su utilización por ser la implementación más estándar. La extensión de SOAP ofrece un conjunto de clases, funciones y constantes para implementar un servicio web y un cliente consumiendo un servicio web. XML-RPC Es una extensión experimental de PHP por lo tanto no se recomienda su aplicación en proyectos profesionales. Estas funciones se pueden usar para escribir servidores y clientes XML-RPC. Soporte XML de PHP Adicionalmente PHP ofrece todas las facilidades para acceder a documentos y manipular documentos en formato XML, de cualquier modo DOM y secuencial con el API estándar de XML. Obviamente el desarrollar los servicios web empleando estas facilidades requiere un gran dominio de todos los protocolos y conceptos de servicios web sin utilizar ninguna abstracción. Librerías externas Existen librerías para desarrollar servicios Web en PHP las cuales ofrecen niveles de abstracción facilitando el desarrollo de las soluciones. Por ejemplo, NuSOAP es un kit de herramientas (ToolKit) para desarrollar servicios web en el lenguaje PHP. Está compuesto por una serie de clases permintiendo de una manera más fácil el desarrollo de servicios web. NuSOAP, provee soporte para el desarrollo de clientes (aquellos que consumen los Web Services) y de servidores (aquellos que los proveen). NuSOAP está basado en SOAP 1.1, WSDL 1.1 y HTTP 1.0/1.1 Tecnología utilizada en este curso El resto del material se basa en el desarrollo de servicios web con la librería externa NuSOAP y con la extensión SOAP de PHP, por ser ambas tecnologías estables y adherirse a los estándares. LECCION 9 Proyecto NuSOAP SourceForge.Net NuSOAP forma parte de un proyecto de sourceforge.net. NuSOAP es una capa de abstracción sobre SOAPx4, provista por la empresa NuSphere and Dietrich Ayala. Es un conjunto de clases PHP, no es necesario incluir ninguna extensión y permite a los desarrolladores crear y consumir servicios web basándose en SOAP 1.1, WSDL 1.1 y HTTP 1.0/1.1. La página del proyecto en sourceforge.net se encuentra en el URL Y la página oficial del proyecto es En la página del proyecto se pueden ubicar las descargas del código PHP para NuSOAP. Todos los derechos reservados, prohibida la reproducción, Instituto Gala de Venezuela 12

13 La última actualización de este proyecto tiene fecha de abril 2010 con la versión LECCION 10 Librería NuSOAP La librería NuSOAP se encuentra totalmente desarrollada en Clases, por lo que se requiere dominar la Programación Orientada por Objetos en PHP, disponible desde PHP 4.x, pero preferiblemente utilizar PHP 5.x Al descargar la aplicación, se debe descargar también la documentación, la cual esta generada en HTML con el generador de documentos de PHP, phpdocumentor. Al desplegar en un navegador web HTML el índice aparece la siguiente documentación en ingles. La Librería se compone de un conjunto de archivos de PHP conteniendo: Clases (la mayoría del código se encuentra desarrollado en clases) Funciones LECCION 11 Clases NuSOAP Desde el punto de vista de programación NuSOAP es un conjunto de clases permitiendo desarrollar servicios web (servidores) y consumir servicios web (clientes). Ofreciendo las características inherentes a la tecnología de servicios web. A continuación se muestra el diagrama de clases en nusoap, una clase en la rama (debajo) de otra extiende o hereda a esta clase. Todos los derechos reservados, prohibida la reproducción, Instituto Gala de Venezuela 13

14 Existe una clase raíz, llamada nusoap_base conteniendo los fundamentos de la librería. La clase nusoap_client permite implementar un cliente consumidor de servicios web. La clase nusoap_server implementa el servicio web. La clase wsdl permite definir las especificaciones wsdl del servicio: los tipos de datos, las funciones del servicio, etc. Clase nusoap_base Es la raíz de nusoap, todas las clases las derivan. Tiene todos los elementos base de nusoap. Clase nusoap_client Implementa un cliente consumiendo un servicio web, su utilización requiere los siguientes pasos: 1) Instanciar en cliente con la información del servidor donde se encuentran los servicios $soapclient = new nusoap_client( string path [,mixed wsdl] ); 2) Invocar al servicio requerido $soapclient->call( string methodname [,array parameters] ); 3) Cerrar el cliente Unset($soapclient): Clase nusoap_parser Realiza el parsing de los mensajes SOAP XML convirtiéndolos en valores PHP nativos Clase nusoap_server Todos los derechos reservados, prohibida la reproducción, Instituto Gala de Venezuela 14

15 Permite crear un servidor SOAP capaz de recibir mensajes y enviar respuestas Clase wsdl Realiza el parsing de un archivo WSDL, permitiendo acceder a los datos y a los métodos utilitarios. También permite crear estructuras WSDL programáticamente. Compatibilidad con versiones anteriores Para permitir compatibilidad hacia atrás, las siguientes clases definen los clientes, los servidores y los parser asi las extensiones de SOAP hayan sido cargadas soapcliente extiende nusoap_ client soapparser extiende nusoap_ parser soapserver extiende nusoap_ server LECCION 12 Consumiendo servicios WEB NOTA: En estas lección se muestran ejemplos de sitios web reales publicados por sitios fuera del Instituto Gala, por lo tanto el Instituto no se hace responsable si al momento de su ejecución o pruebas el servicio web ya no se encuentra disponible. A continuación se muestra un ejemplo del consumo un servicio web ubicado en el URL El resultado es el siguiente Todos los derechos reservados, prohibida la reproducción, Instituto Gala de Venezuela 15

16 En este ejemplo se tiene un servicio web para obtener la hora local para un zip code en específico. Depende de la implementación del servicio, pero por lo general todos ofecen un listado de los métodos soportados, en este caso se ofrece el método LocalTimeByZipCode. Para consumirlo, esto depende del servicio no es una receta exacta pero por lo general todos los servicios ofrecen una manera de consumirse, en este ejemplo, : desde el navegador se realiza click al enlace de LocalTimeByZipCode luego se selecciona la opción TestForm Se coloca en el valor de ZIP que corresponde a un área de Colorado. Se presiona el botón INVOKE En la siguiente figura, se muestra este ejemplo Produciendo como resultado un mensaje SOAP conteniendo el resultado Todos los derechos reservados, prohibida la reproducción, Instituto Gala de Venezuela 16

17 En este ejemplo el resultado es 11 de marzo de 2013 a las 16 horas, 24 minutos, 13 segundos. Cuando se invocó el servicio web también se construyó un mensaje SOAP conteniendo la llamada del método con el parámetro Zip con el valor de Por regla general, si se requiere conocer el detalle de la especificación del servicio web se invoca el servidor con el parámetro wsdl de la siguiente manera : Todos los derechos reservados, prohibida la reproducción, Instituto Gala de Venezuela 17

18 Los metodos utilizados en el servicio web se encuentran en la sección de operaciones, por ejemplo en el método LocalTimeByZipCode utilizado recibe como parámetro de entrada un string y devuelve como salida un string Los tipos de datos utilizados se definen en la sección de tipos LECCION 13 Desarrollo de un cliente en PHP empleando las clases de NuSOAP En esta lección se desarrollara el código fuente para consumir un servicio web, utilizaremos el ejemplo anterior. A continuación se muestra el código en PHP Al ejecutarlo en el servidor se produce el siguiente resultado Todos los derechos reservados, prohibida la reproducción, Instituto Gala de Venezuela 18

19 Explicación del código fuente: 1. Se debe incluir la librería de nusoap en el archivo php 2. Se crea una instancia del cliente, en el primer parámetro se coloca el URL (notar que se coloca el parámetro de wdsl) en el segundo parámetro se coloca el tipo de URL 3. Se deben llenar los parámetros del servicio WEB, la clase requiere se construya un arreglo asociativo (tabla de hash) donde la clave es el nombre del parámetro y el valor es el valor del parámetro 4. Se invoca el método call del cliente, el primer parámetro es un string conteniendo el nombre del método y el segundo parámetro el arreglo conteniendo los parámetros 5. En este caso, el método del servicio web devuelve un arreglo asociativo conteniendo el resultado en la clave con el mismo nombre del método y el sufijo Result Punto de atención: Debe conocerse el nombre de los métodos del servicio web así como los parámetros de entrada y los parámetros de salida. Especificacion API del constructor Constructor nusoap_client (line 7169) constructor access: public nusoap_client nusoap_client (mixed $endpoint, [mixed $wsdl = false], [string $proxyhost = false], [string $proxyport = false], [string $proxyusername = false], [string $proxypassword = false], integer $timeout, [integer $response_timeout = 30], [string $portname = '']) mixed $endpoint: URL del servidor SOAP server o el WSDL URL (string), o una instancia del obejto wsdl mixed $wsdl: opcional, se coloca el string 'wsdl' o true si se trabaja con WSDL string $proxyhost: opcional, si el servicio funciona en proxy, aplica para los siguientes 3 parametros string $proxyport: opcional string $proxyusername: opcional string $proxypassword: opcional integer $timeout: opcional, timeout para el requerimiento integer $response_timeout: opcional, timeout para la respuesta string $portname: opcional, nombre del puerto en el documento WSDL Especificacion API del metodo call call (line 7228) invoca el método del servicio web, devuelve el resultado en PHP return: resultado de un requerimiento SOAP, generalmente un arreglo asociativo espejo del resultado XML, devuelve false en caso de errores fatales access: public Todos los derechos reservados, prohibida la reproducción, Instituto Gala de Venezuela 19

20 mixed call (string $operation, [mixed $params = array()], [string $namespace = ' [string $soapaction = ''], [mixed $headers = false], [boolean $rpcparams = null], [string $style = 'rpc'], [string $use = 'encoded']) string $operation: servidor SOAP server, URL o camino, por lo general es el nombre del método mixed $params: Un arreglo, asociativo o simple, conteniendo los parámetros del método, o un string conteniendo el XML de la llamada.. string $namespace: opcional, el espacio de nombres del método (WSDL lo puede sobreescribir) string $soapaction: opcional valor de SOAPAction (WSDL lo puede sobreescribir) mixed $headers: string o arreglo asociativo conteniendo un encabezado SOAP boolean $rpcparams: opcional (no se utiliza) string $style: opcional (rpc document) representa el estilo de socialización utilizado (WSDL lo puede sobreescribir) string $use: opcional (encoded literal) utilizado cuando se serializan los parámetros (WSDL lo puede sobreescribir) LECCION 14 Servidores SOAP en NuSOAP Un servidor SOAP implementa un servicio web en NUSoap, por lo tanto podrá recibir y responder a requerimientos SOAP. Un servidor SOAP en NuSOAP es una archivo PHP implementado con las librerías de PHP y alojado en un servidor como una aplicación php estándar. La librería debe estar alojada en el servidor y el código fuente debe incluirla. La librería recibe los requerimientos en formato SOAP, los procesa y devuelve el resultado en formato SOAP. A continuación se muestra un ejemplo de un servidor SOAP ofreciendo métodos para operaciones matemáticas El código del servidor se llama servidorfuncionesmatematicas.ph Si se ejecuta desde un navegador, el proceso es el mismo de cualquier aplicación PHP Todos los derechos reservados, prohibida la reproducción, Instituto Gala de Venezuela 20