Administrador de Contenido - tablero.gobabiertomx.orgtablero.gobabiertomx.org/files/55afb1f959af8.pdf · Plataforma Java con la librería JAX-WS. CONSUMIR SERVICIOS WEB DE EJEMPLO

Administrador de Contenido

Memoria Técnica de Servicios Web para SNB II

INSTITUTO TECNOLÓGICO SUPERIOR DE COSAMALOAPAN ADMINISTRADOR DE CONTENIDO

HOJA 1 DE 21

PROCESO

FECHA MARZO-2015

Memoria Técnica de Servicios Web para SNB

TABLA DE CONTENIDO

INTRODUCCION ............................................................................................................................. 2

COMPONENTES .............................................................................................................................. 2

Publicación de Servicios Web ....................................................................................................................... 2

Consumir servicios web de ejemplo ............................................................................................................. 2

WSDL DE CONEXIÓN .................................................................................................................... 2

Ambiente de Pruebas .................................................................................................................................. 2

Ambiente de Producción.............................................................................................................................. 2

Consideraciones ........................................................................................................................................... 3

MÉTODOS PRINCIPALES PARA EL SNB .................................................................................. 3

openSession ................................................................................................................................................. 3

closeSesion .................................................................................................................................................. 6

executeService ............................................................................................................................................. 7

FLUJO DE SOLICITUDES PARA EL SNB. .................................................................................. 9

DIAGRAMA DE FLUJO PARA EL SNB..................................................................................... 10

MÉTODOS PARA LA OPERACIÓN DEL SNB. ....................................................................... 10

Operaciones de Consulta ........................................................................................................................... 10

Operaciones de Actualización .................................................................................................................... 16

SERVICIOS WEB DESARROLLADOS POR LA INSTITUCIÓN .......................................... 18


HOJA 2 DE 21

PROCESO

FECHA MARZO-2015


INTRODUCCION El presente documento describe los datos de conexión a los servicios web publicados para el Sistema Nacional de Becas (SNB), como también un ejemplo de la petición y respuesta de los mismos.

COMPONENTES A continuación se describen las tecnologías utilizadas para la publicación de los servicios web, de igual forma se mencionan herramientas disponibles para realizar peticiones a los servicios web, sin embargo, se debe considerar que el desarrollador deberá implementar o utilizar la herramienta que se adecue a sus necesidades para invocar las peticiones correspondientes.

PUBLICACIÓN DE SERVICIOS WEB Plataforma Java con la librería JAX-WS. CONSUMIR SERVICIOS WEB DE EJEMPLO Para consumir los servicios web, se utilizaron 2 herramientas de prueba, la primera fue una implementación en Java y la segunda herramienta es SoapUI. Nota: En el desarrollo del cliente que consumirá los servicios web publicados por el Sistema Nacional de Becas, se deberá tener en cuenta que el EndPoint puede cambiar, un ejemplo puede ser del ambiente de pruebas al ambiente productivo, el cual se notificara previamente por el oficio correspondiente, sin embargo, se debe contemplar este dato como una variable en el desarrollo por parte de las instituciones que consumirán los servicios web que se describen en el presente documento.

WSDL DE CONEXIÓN AMBIENTE DE PRUEBAS

http://systemscc.com/TasksServerWeb/TaskService?WSDL

AMBIENTE DE PRODUCCIÓN Pendiente por definir.

http://systemscc.com/TasksServerWeb/TaskService?WSDL


HOJA 3 DE 21

PROCESO

FECHA MARZO-2015


CONSIDERACIONES Todas las respuestas de los servicios web desarrollados para el Sistema Nacional de Becas, tienen como respuesta un tipo de dato String, en formato JSON, el cual se implementó de esta forma por considerarse que es de fácil manejo en todas las tecnologías actuales, por lo cual se recomienda realizar el “parseo” correspondiente de la respuesta de tipo String a un formato JSON con respecto a la tecnología usada para la implementación del cliente que consumirá dichos servicios.

MÉTODOS PRINCIPALES PARA EL SNB OPENSESSION Método de Inicio de sesión. Es importante configurar la opción de mantener sesión al cliente que invoca el método, los parámetros de acceso deberán ser proporcionados por el administrador del SNB, este método deberá ser invocado, antes de la ejecución de cualquier otro servicio web. Parámetros de entrada

Tipo de dato Nombre Descripción Valor

String userAppKey Usuario asignado al sistema. userTest

String userAppToken Contraseña. userTest

Integer userTaskId Valor fijo. -1

Entrada ejemplo (Cliente Java):

openSession("userTest", "userTest", -1);


HOJA 4 DE 21

PROCESO

FECHA MARZO-2015


Respuesta de tipo String y formato JSON, con los siguientes datos:

Tipo de dato

Nombre Descripción Valor

String errorMessage Mensaje general de la ejecución del método.

String result Resultado en formato JSON de la ejecución del método, la estructura del resultado depende del método ejecutado.

Integer pageCount Número de páginas resultantes en caso de paginar.

Para este método siempre regresara 1

Integer count Cantidad de registros devuelta en el parámetro de salida“result”.

Boolean error Error al ejecutar el método.

Integer Page Numero de página actual. Para este método siempre regresara 1

Boolean inSession Si el usuario ejecuto el método con sesión abierta.

Respuesta ejemplo (Cliente Java):

{"errorMessage":"","result":{"user":{"id":11647,"area":null,"values":{},"location":null,"email":"","description":"Usuario de prueba","name":null,"image":null,"key":"userTest"},"profiles":[]},"pageCount":1,"count":1,"error":false,"page":1,"inSession":true}

SoapUI Ejemplo:


HOJA 5 DE 21

PROCESO

FECHA MARZO-2015



HOJA 6 DE 21

PROCESO

FECHA MARZO-2015


CLOSESESION Cierre de sesión. Parámetros de entrada


N/A

Entrada ejemplo (Cliente Java)

closeSession()




Boolean result Resultado de la ejecución del método, la estructura del resultado depende del método ejecutado.


Para este método siempre regresara 1

Integer count Cantidad de registros devuelta en el parámetro de salida “result”.


Integer Page Numero de página actual. Para este método siempre regresara 1


Respuesta ejemplo (Cliente Java)

{"errorMessage":"","result":true,"pageCount":1,"count":1,"error":false,"page":1,"inSession":true}

SoapUI Ejemplo:


HOJA 7 DE 21

PROCESO

FECHA MARZO-2015


EXECUTESERVICE Servicio web maestro, el cual invoca una tarea específica, debe existir sesión abierta para la ejecución de este método. Parámetros de entrada

Tipo de dato

Nombre Descripción Valor

String serviceName Valor fijo. Sep.snb.services.webservices.GetPostulacion

String jsonArgs Parámetros del servicio en formato JSON.

“{"idOperacion":2}

Integer nativeResult Valor fijo. false

Entrada ejemplo (Cliente Java)

executeService("Sep.snb.services.webservices.GetPostulacion", parametros, false);

Donde:

String parametros = “{\"idOperacion\":2}”




String result Resultado en formato JSON de la ejecución del método, la estructura del resultado depende del método ejecutado.


Integer count Cantidad de registros devuelta en el parámetro de salida “result”.


Integer Page Numero de página actual.



HOJA 8 DE 21

PROCESO

FECHA MARZO-2015


Respuesta ejemplo (Cliente Java) {"errorMessage":"100 OPERACIÓN EXITOSA","result":[{"id":11575,"name":"Solicitud de Beca","key":"solicitud-de-beca","description":"Lleva el tramite de solicitudes de becas","rootPath":"/taskmanager/solicitud-de-beca/solicitud-de-beca/","count":40,"folder":[{"id":null,"name":"Postulación","key":"postulacion","description":"","rootPath":null,"count":19,"folder":null},{"id":null,"name":"Aceptada","key":"aceptada","description":"","rootPath":null,"count":10,"folder":null},{"id":null,"name":"Rechazada","key":"rechazada","description":"","rootPath":null,"count":2,"folder":null},{"id":null,"name":"Captura Complementaria","key":"captura-complementaria","description":"","rootPath":null,"count":9,"folder":null}]}],"pageCount":1,"console":"","count":20,"error":false,"page":1,"inSession":true}

SoapUI Ejemplo:


HOJA 9 DE 21

PROCESO

FECHA MARZO-2015


FLUJO DE SOLICITUDES PARA EL SNB.

El flujo considerado para las solicitudes del SNB consiste en las etapas:

1. Postulación Es la etapa inicial de una solicitud, se espera que la institución conozca las solicitudes nuevas y por medio del llamado a un webservices, ejecute la operación correspondiente para dar seguimiento a la misma.

Servicios web de actualización que interactúan en esta etapa: a. Completar solicitud

2. Sistema Interno Es un proceso de decisión interno que determina en qué etapa se posicionara la solicitud, al momento en que la institución completa la postulación.

Servicios web de actualización que interactúan en esta etapa:

No aplica

3. Espera a institución Etapa en la que espera la solicitud a ser informada de todos los posibles cambio de estatus correspondientes al proceso de otorgamiento de becas de cada institución, hasta que sea marcada como aceptada o rechazada, la solicitud permanecerá en esta etapa.

Servicios web de actualización que interactúan en esta etapa: a. Cambiar estatus de la solicitud b. Aceptar solicitud c. Rechazar solicitud

4. Resultado institución Proceso de decisión interna que valida si la solicitud fue marcada como aceptada o rechazada para posicionarse en la siguiente etapa.


No aplica

5. Aceptada Etapa que muestra las solicitudes que son marcadas como aceptadas y el flujo finaliza en esta etapa.


No aplica

6. Rechazada

Etapa que muestra las solicitudes que son marcadas como rechazadas y el flujo finaliza en esta etapa. Servicios web de actualización que interactúan en esta etapa:

No aplica


HOJA 10 DE 21

PROCESO

FECHA MARZO-2015


DIAGRAMA DE FLUJO PARA EL SNB.

MÉTODOS PARA LA OPERACIÓN DEL SNB. A continuación se describen las operaciones necesarias para el seguimiento a las solicitudes generadas por el SNB. Para la ejecución de las operaciones mencionadas a continuación, se deberá invocar el método executeServices. OPERACIONES DE CONSULTA

1. Contar solicitudes Devuelve el flujo al cual tiene acceso el usuario con el que se inició sesión así como las etapas que integran el flujo y la cantidad de tareas en cada etapa. Los datos de vueltos en esta consulta, servirán para conocer la cantidad total de solicitudes, así como obtener el key que identifica a cada etapa, valor que será requerido para consultar el servicio web denominado “Obtener solicitudes”. Parámetros de entrada


HOJA 11 DE 21

PROCESO

FECHA MARZO-2015


Nombre Valor1 Valor2

serviceName Sep.snb.services.webservices.GetPostulacion

jsonArgs IdOperacion 2

Integer nativeResult false

Respuesta de tipo String y formato JSON, con los siguientes datos: { "count": 20, "console": "", "pageCount": 1, "inSession": true, "errorMessage": "100 OPERACIÓN EXITOSA", "result": [ { "count": 40, "description": "Lleva el tramite de solicitudes de becas", "rootPath": "/taskmanager/solicitud-de-beca/solicitud-de-beca/", "key": "solicitud-de-beca", "folder": [ { "count": 19, "description": "", "rootPath": null, "key": "postulacion", "folder": null, "id": null, "name": "Postulación" }, { "count": 10, "description": "", "rootPath": null, "key": "aceptada", "folder": null, "id": null, "name": "Aceptada" }, { "count": 2, "description": "", "rootPath": null, "key": "rechazada", "folder": null, "id": null, "name": "Rechazada" },


HOJA 12 DE 21

PROCESO

FECHA MARZO-2015


{ "count": 9, "description": "", "rootPath": null, "key": "captura-complementaria", "folder": null, "id": null, "name": "Captura Complementaria" } ], "id": 11575, "name": "Solicitud de Beca" } ], "error": false, "page": 1 }

2. Obtener solicitudes Devuelve una lista de solicitudes en la etapa indicada, este servicio web permite paginación de máximo 50 registros por petición ordenados de forma ascendente. El valor devuelto en el campo idTasksInstance será utilizado para llamar el servicio web denominado “Obtener solicitud” y todos los servicios web de actualización. Parámetros de entrada




nombreFolder Key de la etapa a consultar

registrosPorPagina 50 registros como máximo o especificar un valor

menor

numeroPagina Número de página a consultar



{ "count": 17, "console": "", "pageCount": 1, "inSession": true,


HOJA 13 DE 21

PROCESO

FECHA MARZO-2015


"errorMessage": "100 OPERACIÓN EXITOSA", "result": [ { "fechaCreacion": "2015/07/07 16:30:04", "apellidoMaterno": "BRAVO", "genero": "Hombre", "curp": "TIBD841213HMCRRN05", "idBeca": 59, "pathInfo": "/taskmanager/solicitud-de-beca/postulacion/", "nacionalidad": "MEX", "apellidoPaterno": "TIRO", "key": "SNB-000115 \r\n", "nombre": "DANIEL", "validacion": "", "idTaskInstance": 12152, "email": "", "fechaNacimiento": "1984/12/13" }, { "fechaCreacion": "2015/07/05 00:04:19", "apellidoMaterno": CRUZ, "genero": H, "curp": CUZM730901HDFRMR07, "idBeca": 59, "pathInfo": "/taskmanager/solicitud-de-beca/postulacion/", "nacionalidad": MEX, "apellidoPaterno": ZAMBRANO, "key": "SNB-000092 \r\n", "nombre": "<p>Becas INBA</p>", "validacion": 59, "idTaskInstance": 12062, "email": "", "fechaNacimiento": null } ], "error": false, "page": 1 }

3. Obtener solicitud

Muestra la información correspondiente a cada solicitud independientemente de la etapa en la que se encuentre. Parámetros de entrada



HOJA 14 DE 21

PROCESO

FECHA MARZO-2015




idTarea idTasksInstance devuelto en la ejecución del Servicio web “Obtener solicitudes”



{ "count": 1, "console": "", "pageCount": 1, "inSession": true, "errorMessage": "100 OPERACIÓN EXITOSA", "result": [ { "fechaCreacion": "2015/07/12 17:15:27", "apellidoMaterno": "BRAVO", "genero": "H", "curp": "TIBD841213HMCRRN05", "idBeca": 53, "pathInfo": "/taskmanager/solicitud-de-beca/aceptada/", "nacionalidad": "MEX", "apellidoPaterno": "TIRO", "key": "SNB-000134 \r\n", "nombre": "DANIEL", "validacion": "", "idTaskInstance": 12260, "email": "", "fechaNacimiento": "13/12/1984" } ], "error": false, "page": 1 }

4. Obtener información del solicitante

Este método regresa la información personal de un solicitante, es importante notar que se anexa en la respuesta el correo electrónico y contraseña con un algoritmo de hash MD5, con la intención de poder compartir el mismo inicio de sesión entre un sistema y otro. Parámetros de entrada



HOJA 15 DE 21

PROCESO

FECHA MARZO-2015


serviceName Sep.snb.services.webservices.GetUser

jsonArgs curp CURP



{ "count": 0, "console": "", "pageCount": 1, "inSession": true, "errorMessage": "", "result": { "discapacidad": 0, "grado": 0, "apellidoMaterno": "BRAVO", "rol": 3, "curp": "TIBD841213HMCRRN05", "promedio": 0, "indigena": 0, "verificado": null, "id": 12055, "nombre": "DANIEL", "nacionalidad": "MEX", "email": "[email protected]", "status": "CURP encontrado", "nivel": 2, "genero": "H", "parent": null, "user": null, "modalidad": 1, "password": "8003c7e598aee99585cf39ea0bb24c72", "edad": null, "favorita": null, "apellidoPaterno": "TIRO", "error": "0000", "fechaNacimiento": "13/12/1984" }, "error": false, "page": 1 }


HOJA 16 DE 21

PROCESO

FECHA MARZO-2015


OPERACIONES DE ACTUALIZACIÓN

5. Completar solicitud Método para avanzar la solicitud a la etapa siguiente, este método se considera utilizar para solicitudes que se encuentran en la etapa de Postulación. Parámetros de entrada


serviceName Sep.snb.services.webservices.UpdatePostulacion

jsonArgs idOperacion 1




{ "count": 0, "console": "", "pageCount": 1, "inSession": true, "errorMessage": "100 OPERACIÓN EXITOSA", "result": null, "error": false, "page": 1 }

6. Cambiar estatus de la solicitud

Método para asignar “cambios de estatus a una solicitud” (valor de texto abierto), este servicio web puede ser ejecutado la cantidad de veces necesarias, según corresponda al flujo de otorgamiento de becas de cada institución. Parámetros de entrada





HOJA 17 DE 21

PROCESO

FECHA MARZO-2015


idTarea idTasksInstance devuelto

en la ejecución del Servicio web “Obtener solicitudes”

motivo Descripción del cambio de estatus, ejemplo “Revisión

de documentos”



7. Aceptar solicitud

Aceptar una solicitud. Parámetros de entrada









HOJA 18 DE 21

PROCESO

FECHA MARZO-2015


8. Rechazar solicitud Rechazar solicitud. Parámetros de entrada





Motivo Descripción del motivo de rechazo




SERVICIOS WEB DESARROLLADOS POR LA INSTITUCIÓN Se considera que la institución implemente los servicios web mencionados a continuación con la finalidad de tener la información actualizada en tiempo real. Debido a que el SNB interactúa con varias instituciones otorgantes de becas, se pretende estandarizar la creación de estos servicios, para que la estructura de los mismos, parámetros de envió y respuesta sean los mismos para cualquier institución.

1. Registro de solicitudes e inicio de sesión en línea


HOJA 19 DE 21

PROCESO

FECHA MARZO-2015


Servicio web que será invocado desde el SNB en el momento en que un ciudadano desee postularse a determinada beca, por lo que el SNB identificara a que institución pertenece la beca e invocara el servicio web correspondiente, enviando la información de la beca a postularse así como los datos del ciudadano. En este proceso el servicio web de la institución realizara las validaciones correspondientes a su flujo de otorgamiento de becas. En caso de ser exitoso, deberá indicar mediante un parámetro de respuesta, la URL a la que el SNB deberá redireccionar para que el ciudadano pueda completar información adicional, según sea el caso, previamente el sistema de la institución, inicio sesión para el usuario en cuestión. En caso de existir algún error, el servicio web deberá indicar el mismo en la respuesta, el cual será mostrado en el SNB. Nombre del método PROPUESTO

Postular(jsonArgs); Parámetros de entrada PROPUESTOS


jsonArgs (Formato JSON)

curp CURP

idBeca Id de beca correspondiente a la institución

email

Password

nacionalidad

fechaNacimiento

genero

apellidoPaterno

apellidoMaterno

nombre

Respuesta PROPUESTA de tipo String y formato JSON, con los siguientes datos:

{ "inSession": true, "errorMessage": "100 OPERACIÓN EXITOSA", "error": false, "urlInstitucion": “www.institucion.gob.mx/registro/xxxx” }


HOJA 20 DE 21

PROCESO

FECHA MARZO-2015


2. Cambio de contraseña y correo electrónico de un ciudadano. El objetivo de este servicio web es compartir el inicio de sesión entre el SNB y el Sistema de la institución otorgante, por lo que se considera compartir los datos de acceso al mismo. Nombre del método PROPUESTO

actualizarCredenciales(jsonArgs); Parámetros de entrada PROPUESTOS


jsonArgs (Formato JSON)

curp CURP

email

Password

Respuesta PROPUESTA de tipo String y formato JSON, con los siguientes datos:

{ "errorMessage": "100 OPERACIÓN EXITOSA", "error": false }

Documents

Administrador de Contenido - tablero.gobabiertomx.orgtablero.gobabiertomx.org/files/55afb1f959af8.pdf · Plataforma Java con la librería JAX-WS. CONSUMIR SERVICIOS WEB DE EJEMPLO