viafirma inbox :: manual de integración

Aplicación de ejemplo en Java

En la zona de Documentación de la aplicación Viafirma Inbox existe una aplicación de ejemplo programada en Java que realiza una petición a cada uno de los métodos definidos en al WSDL.

En la página index.jsp de la aplicación de ejemplo hay una serie de variables que hay que modificar para el correcto funcionamiento de la misma:

  • urlConexion: Url donde se encuentra instalado Viafirma Inbox.
  • returnUrl: Dirección de retorno. En este caso redireccionamos a la misma página jsp
  • notificationUrl: Url donde se recibirán las notificaciones. En este ejemplo tenemos creado un servlet que escribe un mensaje en la consola de Java cada vez que se recibe una notificación.
  • System: Sistema utilizado de Viafirma Inbox. Si no está activa la seguridad en la API, este valos es vacío
  • key: Key de API de Viafirma Inbox. Vacío si la seguridad no está activada
  • nifPruebas: Nif de pruebas. En la aplicación de ejemplo (/site/docs) hay un certificado de pruebas (nombre: Juan Gil Palomo, nif: 11111111R, clave: 12345). Este certificado será solicitado por Viafirma para las peticiones asíncronas. Puede ser modificada esta variable con otro nif.
  • WorkflowTest: PublicAccessId del workflow que queremos usar para el ejemplo de redacción de petición utilizando un workflow disponible.

El primer paso para poder realizar una integración con Java, es acceder a la aplicación de ejemplo y copiarnos todo lo necesario. Tendremos que copiar todo el package “com.viafirma.tray.ws”. En este package se encuentran definidos todos los DTO necesarios para enviar los datos de las peticiones y recibir las respuestas. Otra opción sería generar todos los objetos de acceso desde el WSDL directamente.

Existe un servlet en la aplicación de ejemplo “NoficationSevlet.java” que recibirá todas las notificaciones de las peticiones enviadas desde el Webservice. Ahora mismo en dicho servlet simplemente pintaremos por consola el label de la petición modificada, la acción realizada y si se han finalizado o no todas las acciones de la petición.

En función de si tenemos activa o no la seguridad en la API de Viafirma Inbox, tendremos que enviar las cabeceras con los datos de acceso a la API. En el caso de Java, para instanciar el cliente sería como se indica en los siguientes ejemplos (estos ejemplos corresponden a la conexión utilizando el estándar JaxWS):

  • API con seguridad activada:

Api

  • API con seguridad desactivada:

Api

De esta forma, ya tenemos acceso a un objeto ServiceWS que es el que tiene disponibles todos los métodos descritos en el apartado anterior.

En la siguiente captura podemos ver la aplicación de ejemplo:

Api

Cada uno de los enlaces de la aplicación de ejemplo realiza la acción que indica. La acción “Test Request Operations” es un poco especial porque no realiza una única acción. Al pulsar sobre esta acción se realizarán las siguientes operaciones con el API:

  • Envía una petición
  • Añade un comentario a la nueva petición
  • Recupera la información de la petición
  • Recupera los comentarios de la petición
  • Recupera los ficheros a firmar de la petición y pinta un enlace de descarga de cada fichero
  • Recupera los ficheros anexos de la petición y pinta un enlace de descarga de cada fichero.