MANUAL TÉCNICO WEB SERVICE PROTOCOLO SOAP

Transcripción

1 MANUAL TÉCNICO WEB SERVICE PROTOCOLO SOAP

2 ÍNDICE Contenido SERVICIO WEB SOAP... 3 ACCESO A CONSUMIR SERVICIO WEB... 4 EJECUCIÓN DE FUNCIONES... 4 FUNCIÓN SET_SMS... 5 FUNCIÓN SET_SMS_MULTIPLE... 6 FUNCIÓN GET_SMS... 8 FUNCIÓN GET_RESPONSE... 9 REFERENCIAS APOYO PARA CREAR CLIENTE DEL WSSL

3 SERVICIO WEB SOAP SOAP (siglas de Simple Object Access Protocol) es un protocolo estándar que define cómo dos objetos en diferentes procesos pueden comunicarse por medio de intercambio de datos XML. Es uno de los protocolos utilizados en los servicios web. Este protocolo basado en XML consiste de tres partes: un sobre (envelope), el cual define qué hay en el mensaje y cómo procesarlo; un conjunto de reglas de codificación para expresar instancias de tipos de datos; y una convención para representar llamadas a procedimientos y respuestas. El protocolo SOAP tiene tres características principales: Extensibilidad (seguridad y WS-routing son extensiones aplicadas en el desarrollo). Neutralidad (SOAP puede ser utilizado sobre cualquier protocolo de transporte como HTTP, SMTP, TCP o JMS). Independencia (SOAP permite cualquier modelo de programación). Como ejemplo de cómo los procedimientos SOAP pueden ser utilizados, un mensaje SOAP podría ser enviado a un sitio Web que tiene habilitado Web service, para realizar la búsqueda de algún precio en una base de datos, indicando los parámetros necesitados en la consulta. El sitio podría retornar un documento formateado en XML con el resultado, ejemplo, precios, localización, características. Teniendo los datos de respuesta en un formato estandarizado "parseable", este puede ser integrado directamente en un sitio Web o aplicación externa. La arquitectura SOAP consiste de muchas capas de especificación: para el formato del mensaje, MEP (Message Exchange Patterns), subyacentes enlaces de protocolo de transporte, modelo de procesamiento de mensajes, y extensibilidad del protocolo. SOAP es el sucesor de XML-RPC, a pesar de que toma el transporte y la neutralidad de la interacción y el envelope / header / body de otra parte (probablemente de WDDX). (Detalles: 3

4 ACCESO A CONSUMIR SERVICIO WEB Para hacer funcionar el web service de es necesario acceder a la siguiente dirección con conexión segura (barra de direcciones color verde con certificado SSL) que es en este link encontraremos el estándar de los servicios web SOAP, como podemos ver en la siguiente imagen debe desplegar la siguiente pantalla. EJECUCIÓN DE FUNCIONES En el server obtendremos los servicios de set_sms, Set_Sms_Multiple, Get_Sms_Response y Get_Sms, las cuales insertan y consultan los mensajes del usuario con el que usted estará accediendo. Para la ejecución de las funciones tiene que estar registrado ya que para todas las funciones es obligatorio que envíe por parámetro el usuario y contraseña, además de contar con los créditos suficientes para realizar la petición. 4

5 FUNCIÓN SET_SMS Inserta un mensaje (texto) con un destinatario (número celular), fecha y hora en que se programa el envío del mensaje, si los parámetros fecha y hora se envían vacíos se tomara por default se enviara de manera inmediata tomando la fecha y hora actual en que se realizó la ejecución. Set_Sms( userprueba, prueba123, Mensaje de prueba, , , 15:05:00 ); Como respuesta correcta retorna un arreglo con dos posiciones, id del Envío e id del mensaje. array(1) { [0]=> array(2) { ["idenvio"]=> string(6) "742809" ["id_mensaje"]=> string(8) " " } } *sintaxis de ejecución: Set_Sms($usuario, $contrasena,$sms,$destinatario,$fecha,$hora); Variable usuario Contrasena Sms destinatario Fecha hora Tipo (max 160 caracteres) string (10 digitos numericos) (aaaa-mm-dd) (hh:mm:ss) 5

6 FUNCIÓN SET_SMS_MULTIPLE Inserta un mensaje (texto), fecha y hora en que se programa en que se realizara el envío de los mensajes, si estos parámetros fecha y hora se dejan vacíos o nulos se tomara por default la fecha y hora actual, para el destinatario múltiple se crea una combinación de 6 parámetros por cada destinatario y separados por coma y cada combinación será separada por punto y coma, para sí tener una cadena formada de la siguiente manera: Sintaxis combinación: numero1,nombre1,campo1,campo2,campo3,campo4;numero2,nombre2,campo1,campo2,campo 3,campo4; numero3,nombre3,campo1,campo2,campo3,campo4; numero4,nombre4,campo1,campo2,campo3,campo4; Ejemplo combinación: ,juanPerez,campo1,campo2,campo3,campo4; ,Raul jimenez,comprando,vendiendo,corriendo,durmiendo; ,lic Garcia,siguiendo,,,; ,Ana Isabel,recorriendo,,,; Ejemplo de función: Set_Sms_Multiple( userprueba, prueba123, Mensaje de prueba para +NOMBRE+ ya que usted esta +CAMPO1+ en Aguascalientes., ,juanPerez,adquiriendo,campo2,campo3,campo4; ,Raul jimenez,comprando,vendiendo,corriendo,durmiendo; ,lic Garcia,visitando,,,; ,Ana Isabel,recorriendo,,,;, , 15:05:00 ); NOTA: Para añadir los campos dinámicos en el mensaje se agregan de la siguiente manera; el primer campo es el número telefónico, este parámetro no se añade al mensaje ya que es el número de destino del mensaje, el segundo parámetro es el nombre y se añade al mensaje como +NOMBRE+, el tercer parámetro es libre y se agrega +CAMPO1+, el cuarto se agrega como +CAMPO2+, el quinto se añade como +CAMPO3+ y finalmente el sexto se añade como +CAMPO4+, es la manera en cómo se concatenan en el mensaje a enviar por ejemplo: este mensaje es de prueba para +NOMBRE+ y tiene el valor del primer campo como +CAMPO1+, del segundo +CAMPO2+ del tercero como +CAMPO+ Como respuesta correcta retorna una matriz con el número de posiciones dependiente de la cantidad de destinatarios a los que se creó el envío dando en primera posición idenvio en segunda id_mensaje por registro insertado, como lo podemos observar en el siguiente ejemplo. 6

7 array(3) { [0]=> array(2) { ["id_envio"]=> string(6) "665217" ["id_mensaje"]=> string(7) " " } [1]=> array(2) { ["id_envio"]=> string(6) "665217" ["id_mensaje"]=> string(7) " " } [2]=> array(2) { ["id_envio"]=> string(6) "665217" ["id_mensaje"]=> string(7) " " } } *sintaxis de ejecución: Set_Sms_Multiple($usuario, $contrasena,$sms,$combinacion,$fecha,$hora); Variable usuario Contrasena Sms combinacion Fecha hora Tipo (max 160 caracteres) string (xx,xx,xx,xx,xx,xx;) (aaaa-mm-dd) (hh:mm:ss) 7

8 FUNCIÓN GET_SMS Para obtener información de un mensaje ya insertado se envía por parámetro el id del mensaje que se obtuvo como respuesta al haber ejecutado Set_Sms o Set_Sms_Multiple. Get_Sms( userprueba, prueba123, ); Dando como resultado un arreglo con información del mensaje como lo es el texto del mensaje, numero del celular del destinatario, Estatus del mensaje, fecha de registro, fecha programada del envío, fecha en que se envió, en este orden NOTA: Significados de estatus: nuevo: el mensaje no se ha enviado; enviado: el mensaje ha sido enviado a su destinatario correctamente; noenviado: El número del destinatario es invalido y no fue enviado; enviando: el mensaje se encuentra en proceso de envió a al destinatario; blacklist: El número del destinatario lo tiene en black list; errorenred: Fallo el envió del mensaje por cuestiones técnicas del servidor. array(1) { [0]=> array(6) { ["mensaje"]=> string(142) "EJEMPLO DE TEXTO DEL MENSAJE" ["numcelular"]=> string(11) " " ["estatus"]=> string(9) "noenviado" ["fechaprog"]=> string(19) " :18:00" ["fechaenvio"]=> NULL ["fecharegistro"]=> string(19) " :17:37" } } *sintaxis de ejecución: Get_Sms ($usuario, $contrasena,$idmensaje); Variable usuario Contrasena idmensaje Tipo 8

9 FUNCIÓN GET_RESPONSE Para obtener información de respuesta(s) a un envío y a un mensaje en específico ya insertado, se envía por parámetro el id del envío y el id del mensaje que se obtuvo como respuesta al haber ejecutado Set_Sms o Set_Sms_Multiple. Si se requiere obtener todas las respuesta de un envío solo se añade el id del envío y el id del mensaje se deja vacío (Get_Response($usuario,$contrasena,$idEnvio,, ); ). Get_Response( userprueba, prueba123, , , nuevo ); *para obtener todos los mensajes recibidos de todos los estatus Get_Response( userprueba, prueba123, , , ); **Los estatus existentes son: leido, nuevo, respondido y. Dando como resultado un arreglo con los mensajes que se recibieron como respuesta al mensaje enviado. array(1) { [0]=> array(2) { ["mensaje"]=> string(10) "Mensaje Respuesta" ["estatus"]=> string(5) "nuevo" } } *sintaxis de ejecución: Get_Response ($usuario, $contrasena,$idenvio, $idmensaje,$status); Variable usuario Contrasena idenvio idmensaje Status Tipo 9

10 REFERENCIAS APOYO PARA CREAR CLIENTE DEL WSSL Un ejemplo de cliente se encuentra en se puede tomar como ejemplo de cómo ejecutar las funciones disponibles. DESCARGAR LIBRERÍA SOAP para php Instalando CLIENTE desde PHP Instalando CLIENTE desde ASP.NET