Viafirma Inbox - Manual de Integración - v1.5.0

Transcripción

1 Viafirma Inbx - Manual de Integración - v de Octubre de 2011

2 ÍNDICE 1. INTRODUCCIÓN Intrducción SEGURIDAD DEL API DE INTEGRACIÓN Seguridad del API de integración NOTIFICACIONES Ntificacines FUNCIONALIDADES DISPONIBLES Funcinalidades dispnibles DESCRIPCIÓN DE LOS MÉTODOS DEL WSDL Intrducción preparecmpserequest Descripción Parámetrs Respuesta getrequestannexes Descripción Parámetrs Respuesta getgrups Descripción Respuesta ping Descripción Parámetrs Respuesta getrequestcmments Descripción Parámetrs Respuesta: getjbs Descripción Respuesta: getrejecttypes Descripción... 21

3 Respuesta: getstatus Respuesta: preparesignrequest Descripción Parámetrs Respuesta: getrequestdcuments Descripción Parámetrs Respuesta: getusers Descripción Respuesta getrequeststatus Descripción Parámetrs Respuesta: getusersbysearchterm Descripción Parámetrs Respuesta: sendrequest Descripción Parámetrs Respuesta: sendrequestwithstrwrkflw Descripción Parámetrs Respuesta: getrequestinf Descripción Parámetrs Respuesta: preparewrkflwrequest Descripción Parámetrs Respuesta: getactintypes Descripción Respuesta:... 29

4 5.20. getaccesstypes Descripción Respuesta: getwrkflws Descripción Respuesta: evaluateglbalwrkflw Descripción Respuesta: EJEMPLOS DE INTEGRACIÓN Ejempls de integración Aplicación de ejempl en Java Aplicación de ejempl en.net... 36

5 1. INTRODUCCIÓN Intrducción

6 1.1. Intrducción El presente dcument pretende ser una guía de ayuda para integrar aplicacines externas cn la aplicación Viafirma Inbx. En este dcument describirems las funcinalidades que frece el API de integración de Viafirma Inbx, así cm ls métds dispnibles en el WSDL. Si bien desde este WSDL se puede generar códig de acces para prácticamente cualquier platafrma, verems además ds ejempls de integración cn aplicacines desarrlladas en Java y.net. El acces al API de integración se hará accediend a una URL similar a la que adjuntams a cntinuación, dirección dnde se encuentra ubicad el WSDL del API: Además de la URL cncreta (cn la instancia de la aplicación escgida), deberems dispner de unas credenciales de acces al API, cm verems en el siguiente apartad. Viafirma Inbx - Manual de Integración - v1.5.0 Página 6 de 39

7 2. SEGURIDAD DEL API DE INTEGRACIÓN Seguridad del API de integración

8 2.1. Seguridad del API de integración Ls administradres de cada instancia pueden gestinar credenciales de acces al API, que se deberán utilizar en las llamadas a ls servicis web. En este apartad verems cóm un administradr gestina estas credenciales. Desde el panel de cntrl de la aplicación Viafirma Inbx, se permite la cnfiguración del md de acces a la API de integración. Este acces puede ser cnfigurad cm libre securizad. Si la aplicación se encuentra cnfigurada sin seguridad en el API de integración, puede pasar al apartad 3 del presente manual. Sin embarg, est n suele ser así, requiriend las mencinadas credenciales de acces al API. En cas de que la aplicación tenga activada la seguridad en el API, para acceder a ls métds publicads en el WSDL, será necesari dar de alta en el panel de cntrl una aplicación y una key asciada a la misma. Para generar dicha key acceda al panel de cntrl de la aplicación en el apartad del menú de administración titulad Sistemas API. La pantalla que aparecerá será similar a la siguiente: Desde esta pantalla pdrá cnsultar al listad de sistemas que actualmente tienen acces a la API de integración de Viafirma Inbx. Si desea revcar el acces a algun de ests sistemas sl tendrá que eliminarl. Desde este listad se permiten las siguientes pcines: Añadir un nuev sistema: Para crear un sistema sl será necesari que prprcine un nmbre crt y pcinalmente una descripción. Viafirma Inbx - Manual de Integración - v1.5.0 Página 8 de 39

9 Editar un sistema: Pdrá mdificar ls dats prprcinads del sistema. Tenga en cuenta que si mdifica el nmbre crt de un sistema, las aplicacines que usen dich sistema tendrán que actualizar el nmbre. Eliminar un sistema Regenerar key: Pdrá regenerar una nueva key para un sistema existente de frma que tdas las aplicacines que utilizaran dich sistema tendrían que actualizar su key de acces. El WebService de Inbx requiere la identificación del slicitante cn usuari y passwrd haciend us de Jax-ws, según la especificación Web Services Security UsernameTken Prfile 1.0. Ls dats para realizar dicha autenticación sn: Usuari: el nmbre crt del sistema. Passwrd: la key del sistema. Viafirma Inbx - Manual de Integración - v1.5.0 Página 9 de 39

10 3. NOTIFICACIONES Ntificacines

11 3.1. Ntificacines Las aplicacines terceras que utilicen ls servicis web de Viafirma Inbx pdrán, pr ejempl, crear peticines, cnsultar su estad, etc. Sin embarg, en algunas casines n basta cn que estas aplicacines puedan cnsultar el estad de una petición, sin que se requiere que el sistema les ntifique cualquier nvedad sbre estas peticines creadas desde el aplicativ extern. Est está permitid y cntemplad en el API de la platafrma. A la hra de enviar una nueva petición al sistema, entre ls dats que se slicita (si bien n es bligatri) está la URL a la cual Viafirma Inbx enviará las ntificacines de cambis sbre la petición creada. De este md, cuand una ntificación sea mdificada pr tr usuari (firmada, rechazada dad el vist buen), Viafirma Inbx hará un GET HTTP sbre la url prprcinada a la que se le añadirán ls siguientes camps en el query string de la peración: actin: acción realizada sbre la petición (FIRMADO, VISTOBUENO DEVUELTO) label: Public access id de la petición que ha sid mdificada (este parámetr se devuelve entre trs cuand se crea una petición a través del API, e identifica de frma unívca una petición). finished: Este parámetr se enviará sól en el cas de que la petición de la que se recibe la ntificación ha finalizad. Su valr será siempre el mism: k Viafirma Inbx - Manual de Integración - v1.5.0 Página 11 de 39

12 4. FUNCIONALIDADES DISPONIBLES Funcinalidades dispnibles

13 4.1. Funcinalidades dispnibles El API de integración de Viafirma Inbx permite realizar las siguientes accines: Realizar un ping al WS para cmprbar la cnexión cn el mism. Recuperar listad de tds ls usuaris activs del sistema Buscar usuari pr el camp Persn Id Buscar usuaris pr un camp de text Recuperar listad de cargs Recuperar listad de grups Recuperar listad de wrkflws públics Recuperar tips de rechazs cnfigurads en el sistema Recuperar tips de estad dispnibles para una petición Recuperar tips de accines dispnibles para una petición Recuperar tips de acces a la aplicación de verificación para una petición Enviar una petición Añadir cmentaris a una petición Recuperar infrmación de una petición Recuperar ls cmentaris de una petición Recuperar ls fichers de una petición y su enlace de descarga Redacción de una petición de firma desde la aplicación Viafirma Inbx y redirección al sistema extern Redacción de una petición de firma desde la aplicación Viafirma Inbx aplicand un fluj existente en el sistema y redirección al sistema extern Firma de un ficher desde la aplicación Viafirma Inbx y redirección al sistema extern Evaluar un fluj glbal, recuperand las líneas de firma (destinataris) Viafirma Inbx - Manual de Integración - v1.5.0 Página 13 de 39

14 Viafirma Inbx - Manual de Integración - v1.5.0 Página 14 de 39

15 5. DESCRIPCIÓN DE LOS MÉTODOS DEL WSDL Descripción de ls métds del WSDL

16 5.1. Intrducción Tdas las respuestas prprcinadas pr ls métds del API de integración de Viafirma Inbx cntendrán siempre la siguiente infrmación (a parte de la infrmación específica del métd en cncret): Errr (blean): indica si ha habid errr n en la petición RespnseCde (String): Códig de respuesta ErrrMessage (String): Si ha currid un errr en la petición, el mensaje de errr describiend el errr currid A cntinuación se enumeran ls psibles códigs de errr que devlverían ls servicis web: SUCCESS, WS_ERROR_CODE_0, // Empty request id - Errr id petición vací WS_ERROR_CODE_1, // Unable t retrieve request inf - Errr al recuperar petición WS_ERROR_CODE_2, // Unable t retrieve WS User - Errr al recuperar el usuari anónim WS WS_ERROR_CODE_3, // Unable t create cmment - Errr al crear el cmentari WS_ERROR_CODE_4, // Empty cmment errr - Errr cmentari vací WS_ERROR_CODE_5, // Empty user ID errr - Errr nif vací WS_ERROR_CODE_6, // Recipient nt fund errr - Errr destinatari n existe WS_ERROR_CODE_7, // Unable t create request - Errr insertand petición WS_ERROR_CODE_8, // Unknwn - Request actin type - Acción de petición inexistente WS_ERROR_CODE_9, // Request access level empty r nt fund - Tip de acces a petición vací n existe WS_ERROR_CODE_10, // Repeated users in request - Usuaris repetids en la petición WS_ERROR_CODE_11, // Empty recipients list - ista de destinataris vacía WS_ERROR_CODE_12, // Empty dcuments list - Lista de dcuments vacía Viafirma Inbx - Manual de Integración - v1.5.0 Página 16 de 39

17 WS_ERROR_CODE_13, // N dcument name fund - Nmbre del dcument vací WS_ERROR_CODE_14, // Empty dcument cntent - Cntenid del dcument vací WS_ERROR_CODE_15, // Empty wrkflw ID - Id de fluj vací WS_ERROR_CODE_16, // Wrng Inbx Instance - Instancia de Inbx incrrecta WS_ERROR_CODE_17, // User nt fund - Usuari n encntrad WS_ERROR_CODE_18, // Unable t dwnlad signed dcument - N se puede descargar el dcument firmad WS_ERROR_CODE_19, // The request is nt finished r errr while retrieving last signature - Petición incmpleta prblema al recuperar la última firma WS_ERROR_CODE_20, // Unable t retrieve stred signature dcument - Errr recuperand el dcument de firma custdiad WS_ERROR_CODE_21, // Unable t retrieve pdf reprt - N se puede descargar el infrme en pdf WS_ERROR_CODE_22, // Request nt cmpleted - La petición de firma aún n está terminada WS_ERROR_CODE_23, // Unable t generate PDF signature reprt - Errr generand el infrme de firma en pdf WS_ERROR_CODE_24, // Unable t fund wrkflw, nt glbal r nt in this instance - Wrkflw n lcalizad, n es de la instancia n es glbal WS_ERROR_CODE_25, // Errr while evaluating glbal wrkflw - Errr evaluand el wrkflw glbal WS_ERROR_CODE_26, //Errr evaluating wrkflw string representatin // Errr evaluand la representación String del wrkflw WS_ERROR_CODE_401; // Authenticatin errr - Errr de autenticación 5.2. preparecmpserequest Descripción Prepara una petición y devuelve la dirección a la que tendrems que redireccinar. Una vez enviada la petición al WS, la aplicación tendrá que redireccinar a una ventana de navegadr a la url prprcinada en la repuesta de la llamada dnde se slicitará el certificad digital del usuari que envía la petición. Tras prprcinar dich certificad, aparecerá la pantalla de redacción de peticines cn ls dats ya cumplimentads (except el destinatari de la Viafirma Inbx - Manual de Integración - v1.5.0 Página 17 de 39

18 petición). Al pulsar el btón de Enviar, una vez enviada la petición, el usuari será redireccinad a la url de retrn prprcinada en la petición inicial. A md resumen, la secuencia de pass a seguir sn ls siguientes: Realizar una petición a preparecmpserequest pasand dats (firmante,ficher, etc.). En la respuesta viene una URL. Hacer redirect a esa URL (salt). El usuari está en la pantalla de redacción de peticines de firma, ya en la pantalla cn dats precargads: el ficher, el asunt, etc. Cuand el usuari envía la petición, Inbx respnde a la URL de retrn pasada en la llamada del pas 1. En esa URL Inbx pasa pr querystring ls siguientes dats: res= k si td ha id bien errres (prticinnexiste, usercancel, errrviafirma, ) message= (si hay errr, mensaje de errr) label= ID de la petición creada (Ej. R032-ICG9-RDD0-KWHR ) Parámetrs PersnId (String): PersnId del usuari remitente de la petición (deberá ser el mism que lueg seleccine su certificad) DcumentName (String): Nmbre del dcument enviad DcumentCntent (byte[]): Byte array del dcument enviad ReturnUrl (String): Url dnde se redireccinará al usuari al enviar la petición NtificatinUrl (String): Url dnde se ntificarán ls cambis realizad en la nueva petición creada Respuesta CmpseRequestRespnseDTO Viafirma Inbx - Manual de Integración - v1.5.0 Página 18 de 39

19 RedirectUrl: Url dnde tendrems que redireccinar el navegadr para que salte la pantalla de redacción de Viafirma Inbx getrequestannexes Descripción Recupera el listad de dcuments anexs a una petición Parámetrs RequestId (String): Id de la petición de la que se desea recuperar la infrmación Respuesta RequestAnnexesRespnseDTO DcumentDTO (Array): Array cn la infrmación de cada un de ls dcuments así cm la url de acces direct a la descarga del dcument getgrups Descripción Recupera el listad de grups de trabaj dispnibles en Viafirma Inbx Respuesta GrupsRespnseDTO GrupDTO (Array): Array cn la infrmación de cada un de ls grups. Un de ls camps devuelts es el publicaccessid que es el que tendrá que ser usad en el rest de métds de la API. Viafirma Inbx - Manual de Integración - v1.5.0 Página 19 de 39

20 5.5. ping Descripción Métd para hacer test de WS Parámetrs Param (String): Cadena de text que será devuelta en la respuesta Respuesta PingRespnseDTO Result (String): La misma cadena pasada pr parámetr al métd 5.6. getrequestcmments Descripción Recupera el listad de cmentaris asciads a una petición Parámetrs RequestId (String): Id de la petición a la que se desea añadir el cmentari Respuesta: GetRequestCmmentsRespnseDTO RequestCmmentDTO (Array): Array cn la infrmación de cada un de ls cmentaris realizads a la petición cn id pasad pr parámetr. Viafirma Inbx - Manual de Integración - v1.5.0 Página 20 de 39

21 5.7. getjbs Descripción Recupera el listad de cargs dispnibles en Viafirma Inbx Respuesta: JbsRespnseDTO JbDTO (Array): Array cn la infrmación de cada un de ls cargs. Un de ls camps devuelts es el publicaccessid que es el que tendrá que ser usad en el rest de métds de la API getrejecttypes Descripción Recupera el listad de mtivs de rechaz dispnibles en Viafirma Inbx Respuesta: getrejecttypesrespnsedto RejectTypeDTO (Array): Array cn la infrmación de cada un de ls mtivs de rechaz getstatus Recupera el listad de psibles estads en ls que se puede encntrar una petición cn respect a un usuari en cncret Respuesta: getstatusrespnsedto StatusDTO (Array): Array cn la infrmación de cada un de ls psibles estads. Viafirma Inbx - Manual de Integración - v1.5.0 Página 21 de 39

22 5.10. preparesignrequest Descripción Prepara una petición de firma y devuelve la dirección a la que tendrems que redireccinar. Una vez enviada la petición de firma, la aplicación tendrá que redireccinar a una ventana de navegadr a la url prprcinada en la repuesta de la llamada dnde se slicitará el certificad digital del usuari que envía la petición para realizar la firma del ficher enviad. Tras prprcinar dich certificad y realizar la firma del ficher, el usuari será redireccinad a la url de retrn prprcinada en la petición inicial. A md resumen, la secuencia de pass a seguir sn ls siguientes: 1. Realizar una petición a preparesignrequest pasand dats (firmante, ficher, etc.). En la respuesta viene una URL. 2. Hacer redirect a esa URL (salt). El usuari será reenviad a la pantalla de firma dnde tendrá que seleccinar su certificad. 3. Cuand el usuari firma la petición, Inbx respnde a la URL de retrn pasada en la llamada del pas 1. En esa URL Inbx pasa pr querystring ls siguientes dats: res= k si td ha id bien errres (prticinnexiste, usercancel, errrviafirma, ) message= (si hay errr, mensaje de errr) label= ID de la petición creada (Ej. R032-ICG9-RDD0-KWHR ) Parámetrs PersnId (String): PersnId del usuari remitente de la petición (deberá ser el mism que lueg seleccine su certificad) DcumentName (String): Nmbre del dcument enviad DcumentCntent (byte[]): Byte array del dcument enviad ReturnUrl (String): Url dnde se redireccinará al usuari al enviar la petición NtificatinUrl (String): Url dnde se ntificarán ls cambis realizad en la nueva petición creada Respuesta: SignRequestRespnseDTO Viafirma Inbx - Manual de Integración - v1.5.0 Página 22 de 39

23 RedirectUrl: Url dnde tendrems que redireccinar el navegadr para que el usuari realice la firma del ficher getrequestdcuments Descripción Recupera el listad de dcuments a firmar asciads a una petición Parámetrs RequestId (String): Id de la petición a la que se desea recuperar ls fichers Respuesta: GetRequestDcumentsRespnseDTO RequestDcumentDTO (Array): Array cn la infrmación de cada un de ls dcuments a firmar asciads a la petición cn id pasad pr parámetr getusers Descripción Recupera el listad de usuaris activs en Viafirma Inbx Respuesta getusersrespnsedto UserDTO (Array): Array cn la infrmación de cada un de ls usuaris recuperads. Viafirma Inbx - Manual de Integración - v1.5.0 Página 23 de 39

24 5.13. getrequeststatus Descripción Recupera el estad de la petición para cada un de ls destinataris de la misma Parámetrs RequestId (String): Id de la petición a la que se desea recuperar ls fichers Respuesta: GetRequestStatusRespnseDTO RequestAddresseeDTO (Array): Array cn la infrmación de cada un de ls destinataris de la petición y el estad en el que se encuentra la misma para dich destinatari getusersbysearchterm Descripción Recupera el listad de usuaris activs de Viafirma Inbx que cumplen el criteri de búsqueda Parámetrs SearchTerm (String): Términ de búsqueda pr el que se hará el filtrad de ls usuaris Respuesta: getusersrespnsedto UserDTO (Array): Array cn la infrmación de cada un de ls usuaris recuperads. Viafirma Inbx - Manual de Integración - v1.5.0 Página 24 de 39

25 5.15. sendrequest Descripción Inserta una nueva petición Parámetrs request (RequestDTO): El bjet RequestDTO que se insertará, cn ls siguientes camps cmpletads: subject message reference expiratindate accesstype accessuser accesspasswrd blntifyifread blntifyifreturned blntifyifsigned addressees (RequestUserDTO[ ][ ][ ]): Array que cntiene el fluj de firma cmplet (líneas, grups y usuaris). Cada bjet RequestUserDTO cntiene un persn Id y la acción a realizar. La acción es de tip ActinType (el sistema dispne de un métd para recuperar ls ActinType dispnibles: F = firma, VB = vist buen). NOTA: existe el métd evaluateglbalwrkflw, que evalúa un fluj GLOBAL existente en la instancia, analizar ls destinataris, y recuperar un bjet de este tip RequestUserDTO[ ][ ][ ], de frma que se puede realizar primer esta llamada, y psterirmente sendrequest. dcuments (DcumentDTO[ ]): Array que cntiene ls dcuments a firmar. Cada DcumentDTO debe tener ls siguientes camps cmpletads: signtype fileextensin filename filemimetype Viafirma Inbx - Manual de Integración - v1.5.0 Página 25 de 39

26 reference annexes (DcumentDTO[ ]): Array que cntiene ls dcuments anexs de la petición. Cada DcumentDTO debe tener ls siguientes camps cmpletads: signtype fileextensin filename filemimetype reference Respuesta: SendRequestRespnseDTO RequestDTO: Objet cn tda la infrmación relacinada cn la nueva petición creada sendrequestwithstrwrkflw Descripción Similar a sendrequest, cn la principal diferencia que en lugar de usar un bjet RequestUserDTO[][][], utiliza la representación (String) de un wrkflw en la caja predictiva de Viafirma Inbx. Pr ejempl: "NOMBRE USUARIO 1" [usuari1@ viafirma.cm] >"NOMBRE USUARIO 2" [usuari2@viafirma.cm]>. También se dispne de un métd evaluateglbalwrkflw, que devuelve un bjet cn esa representación String, de frma que se puede llamar primer a ese métd, y pasar el resultad cm parámetr a este sendrequestwithstrwrkflw Parámetrs request (RequestDTO): El bjet RequestDTO que se insertará, cn ls siguientes camps cmpletads: subject message reference Viafirma Inbx - Manual de Integración - v1.5.0 Página 26 de 39

27 expiratindate accesstype accessuser accesspasswrd blntifyifread blntifyifreturned blntifyifsigned wrkflwstringrepresentatin (String): representación String del wrkflw, pr ejempl: "NOMBRE USUARIO 1" viafirma.cm] >"NOMBRE USUARIO 2" dcuments (DcumentDTO[ ]): Array que cntiene ls dcuments a firmar. Cada DcumentDTO debe tener ls siguientes camps cmpletads: signtype fileextensin filename filemimetype reference annexes (DcumentDTO[ ]): Array que cntiene ls dcuments anexs de la petición. Cada DcumentDTO debe tener ls siguientes camps cmpletads: signtype fileextensin filename filemimetype reference Respuesta: SendRequestRespnseDTO RequestDTO: Objet cn tda la infrmación relacinada cn la nueva petición creada. Viafirma Inbx - Manual de Integración - v1.5.0 Página 27 de 39

28 5.17. getrequestinf Descripción Recupera la infrmación general de una petición Parámetrs RequestId (String): Id de la petición a la que se desea recuperar ls fichers Respuesta: GetRequestInfRespnseDTO RequestDTO: Objet cn la infrmación asciada a la petición cuy id crrespnde al pasad pr parámetr preparewrkflwrequest Descripción Prepara una petición y devuelve la dirección a la que tendrems que redireccinar. Una vez enviada la petición, la aplicación tendrá que redireccinar a una ventana de navegadr a la url prprcinada en la repuesta de la llamada dnde se slicitará el certificad digital del usuari que envía la petición. Una vez prprcinad dich certificad, aparecerá la pantalla de redacción de peticines cn ls dats ya cumplimentads junt cn ls destinataris a ls que se enviará la petición (en función del wrkflw seleccinad). Al pulsar el btón de Enviar, una vez enviada la petición, el usuari será redireccinad a la url de retrn prprcinada en la petición inicial. A md resumen, la secuencia de pass a seguir sn ls siguientes: 1. Realizar una petición a preparewrkflwrequest pasand dats (firmante,ficher, etc.). También debems indicar el publicaccessid del wrkflw que querems utilizar en la petición. En la respuesta viene una URL. 2. Hacer redirect a esa URL (salt). El usuari será reenviad a la pantalla de redacción de peticines cn tds ls dats precargads, inclus ls dats de ls destinataris que serán aquells usuaris que pertenezcan al fluj seleccinad. Viafirma Inbx - Manual de Integración - v1.5.0 Página 28 de 39

29 3. Cuand el usuari pulse el btón de enví de petición, Inbx respnde a la URL de retrn pasada en la llamada del pas 1. En esa URL Inbx pasa pr querystring ls siguientes dats: res= k si td ha id bien errres (prticinnexiste, usercancel, errrviafirma, ) message= (si hay errr, mensaje de errr) label= ID de la petición creada (Ej. R032-ICG9-RDD0-KWHR ) Parámetrs PersnId (String): PersnId del usuari remitente de la petición (deberá ser el mism que lueg seleccine su certificad) DcumentName (String): Nmbre del dcument enviad DcumentCntent (byte[]): Byte array del dcument enviad WrkflwId (String): Identificadr públic del wrkflw seleccinad ReturnUrl (String): Url dnde se redireccinará al usuari al enviar la petición NtificatinUrl (String): Url dnde se ntificarán ls cambis realizad en la nueva petición creada Respuesta: WrkflwRequestRespnseDTO RedirectUrl: Url dnde tendrems que redireccinar el navegadr para que salte la pantalla de redacción de Viafirma Inbx getactintypes Descripción Recupera el listad de accines dispnibles a realizar en una petición de Viafirma Inbx Respuesta: getactintypesrespnsedto ActinTypeDTO (Array): Array cn la infrmación de cada una de las accines dispnibles. Viafirma Inbx - Manual de Integración - v1.5.0 Página 29 de 39

30 5.20. getaccesstypes Descripción Recupera el listad de psibles access a la herramienta de verificación Respuesta: getaccesstypesrespnsedto AccessTypeDTO (Array): Array cn la infrmación de cada una de ls tips de acces dispnibles getwrkflws Descripción Recupera el listad de wrkflws dispnibles en Viafirma Inbx Respuesta: getwrkflwsrespnsedto WrkflwDTO (Array): Array cn la infrmación de cada un de ls wrkflws dispnibles en Viafirma Inbx. Un de ls camps devuelts es el publicaccessid que es el que tendrá que ser usad en el rest de métds de la API evaluateglbalwrkflw Descripción Analiza un wrkflw glbal dispnible en Viafirma Inbx y devuelve un bjet WrkflwUsersDTO que incluye cm atribut una representación String del wrkflw, que puede ser utilizad psterirmente en sendrequestwithstrwrkflw. Sirve así para enviar una petición utilizand un fluj glbal de la misma instancia del usuari WS. Viafirma Inbx - Manual de Integración - v1.5.0 Página 30 de 39

31 Respuesta: WrkflwUsersDTO wrkflwstringrepresentatin (String): String del wrkflw, que puede usarse psterirmente en sendrequestwithstrwrkflw. Viafirma Inbx - Manual de Integración - v1.5.0 Página 31 de 39

32 6. EJEMPLOS DE INTEGRACIÓN Ejempls de integración

33 6.1. Ejempls de integración Aplicación de ejempl en Java En la zna de Dcumentación de la aplicación Viafirma Inbx existe una aplicación de ejempl prgramada en Java que realiza una petición a cada un de ls métds definids en al WSDL. En la página index.jsp de la aplicación de ejempl hay una serie de variables que hay que mdificar para el crrect funcinamient de la misma: urlcnexin: Url dnde se encuentra instalad Viafirma Inbx. returnurl: Dirección de retrn. En este cas redireccinams a la misma página jsp ntificatinurl: Url dnde se recibirán las ntificacines. En este ejempl tenems cread un servlet que escribe un mensaje en la cnsla de Java cada vez que se recibe una ntificación. System: Sistema utilizad de Viafirma Inbx. Si n está activa la seguridad en la API, este vals es vací key: Key de API de Viafirma Inbx. Vací si la seguridad n está activada nifpruebas: Nif de pruebas. En la aplicación de ejempl (/site/dcs) hay un certificad de pruebas (nmbre: Juan Gil Palm, nif: R, clave: 12345). Este certificad será slicitad pr Viafirma para las peticines asíncrnas. Puede ser mdificada esta variable cn tr nif. WrkflwTest: PublicAccessId del wrkflw que querems usar para el ejempl de redacción de petición utilizand un wrkflw dispnible. El primer pas para pder realizar una integración cn Java, es acceder a la aplicación de ejempl y cpiarns td l necesari. Tendrems que cpiar td el package cm.viafirma.tray.ws. En este package se encuentran definids tds ls DTO necesaris para enviar ls dats de las peticines y recibir las respuestas. Otra pción sería generar tds ls bjets de acces desde el WSDL directamente. Existe un servlet en la aplicación de ejempl NficatinSevlet.java que recibirá tdas las ntificacines de las peticines enviadas desde el Webservice. Ahra mism en dich servlet simplemente pintarems pr cnsla el label de la petición mdificada, la acción realizada y si se han finalizad n tdas las accines de la petición. En función de si tenems activa n la seguridad en la API de Viafirma Inbx, tendrems que enviar las cabeceras cn ls dats de acces a la API. En el cas de Java, para instanciar el Viafirma Inbx - Manual de Integración - v1.5.0 Página 33 de 39

34 cliente sería cm se indica en ls siguientes ejempls (ests ejempls crrespnden a la cnexión utilizand el estándar JaxWS): 1. API cn seguridad activada: 2. API cn seguridad desactivada: De esta frma, ya tenems acces a un bjet ServiceWS que es el que tiene dispnibles tds ls métds descrits en el apartad anterir. En la siguiente captura pdems ver la aplicación de ejempl: Viafirma Inbx - Manual de Integración - v1.5.0 Página 34 de 39

35 Cada un de ls enlaces de la aplicación de ejempl realiza la acción que indica. La acción Test Request Operatins es un pc especial prque n realiza una única acción. Al pulsar sbre esta acción se realizarán las siguientes peracines cn el API: Envía una petición Añade un cmentari a la nueva petición Recupera la infrmación de la petición Recupera ls cmentaris de la petición Recupera ls fichers a firmar de la petición y pinta un enlace de descarga de cada ficher Recupera ls fichers anexs de la petición y pinta un enlace de descarga de cada ficher. Viafirma Inbx - Manual de Integración - v1.5.0 Página 35 de 39

36 Aplicación de ejempl en.net En la zna de Dcumentación de la aplicación Viafirma Inbx existe una aplicación de ejempl prgramada en Java que realiza una petición a cada un de ls métds definids en al WSDL. En la página Default.aspx de la aplicación de ejempl hay una serie de variables que hay que mdificar para el crrect funcinamient de la misma: urlcnexin: Url dnde se encuentra instalad Viafirma Inbx returnurl: Dirección de retrn. En este cas redireccinams a la misma página jsp ntificatinurl: Url dnde se recibirán las ntificacines. En este ejempl tenems cread un servlet que escribe un mensaje en la cnsla de Java cada vez que se recibe una ntificación. System: Sistema utilizad de Viafirma Inbx. Si n está activa la seguridad en la API, este valr es vací key: Key de API de Viafirma Inbx. Vací si la seguridad n está activada nifpruebas: Nif de pruebas. En la aplicación de ejempl (/dcs) hay un certificad de pruebas (nmbre: Juan Gil Palm, nif: R, clave: 12345). Este certificad será slicitad pr Viafirma para las peticines asíncrnas. Puede ser mdificada esta variable cn tr nif. WrkflwTest: PublicAccessId del wrkflw que querems usar para el ejempl de redacción de petición utilizand un wrkflw dispnible. Este ejempl realiza las mismas peracines que el ejempl Java anterirmente descrit. Para generar el cliente del WebService en.net Framewrk es necesari realizar las siguientes peracines: Abrir la cnsla de.net Ejecutar el cmand wsdl URL_WSDL en el directri dnde querems generar el cliente Si tenems seguridad activada: 1. Sbreescribir el métd prtected System.Net.WebRequest GetWebRequest(Uri uri) de la clase generada que extiende de System.Web.Services.Prtcls.SapHttpClientPrtcl (La clase debería llamarse ServiceWS ): Viafirma Inbx - Manual de Integración - v1.5.0 Página 36 de 39

37 1. Para instanciar el cliente: Si n tenems seguridad activada: 1. Para instanciar el cliente: Viafirma Inbx - Manual de Integración - v1.5.0 Página 37 de 39

38 Viafirma Inbx - Manual de Integración - v1.5.0 Página 38 de 39

39 viafirma inbx es un prduct de la suite viafirma