Esta guía te ayudará a comenzar a trabajar con las API de Viafirma Documents rápidamente, haciendo uso de los principales servicios con los que deberías poder agregar la utilidad de firma digital a tu negocio.
Para realizar una integración completa con Viafirma Documents desde un sistema externo como puede ser cualquier CRM, SAP, web o aplicación de escritorio se ofrece una API REST que permite el uso de la mayoría de servicios y funcionalidades ofrecidas por el producto.
Para comenzar aquí tienes enlaces y ayuda a la documentación publicada:
- Guía API para desarrolladores
- Configuración de las políticas para integraciones vía API
- Documentación de funcionalidades y ayuda.
- Videotutoriales
- Histórico de versiones
Seguridad
Los servicios del API de Viafirma Documents requieren seguridad, pudiendo optar por mecanismos Basic Authorization y OAuth v2.
Creación de una solicitud de firma
Para la creación de una solicitud haremos uso del servicio que encontrarás en el siguiente apartado de la documentación:
https://doc.viafirma.com/documents/api/latest/es/set_new.html
Los documentos que se envían a firmar se informan al crear la solicitud y existen diferentes posibilidades:
https://doc.viafirma.com/documents/api/latest/es/document_origin.html
Si el proceso de firma cuenta con un formulario o bien el documento hace uso de variables / acrofields y se quiere completar con datos de un sistema externo se puede indicar en el momento de hacer la solicitud:
https://doc.viafirma.com/documents/api/latest/es/forms_from_api.html
Seguimiento de la solicitud
Para hacer un seguimiento de la solicitud tenemos dos mecanismos básicos que son complementarios:
- Recepción de un correo electrónico una vez finalizada la solicitud indicando si se completó, se rechazó, expiró o hubo algún error, incluyendo el documento firmado y/o fichero de auditoría
- Uso de una URL del sistema cliente para recibir feedback del estado de la solicitud (callbackURL). Al llamar al servicio de creación de la solicitud si se indica una URL en el parámetro callbackURL se realizará una llamada POST a esa URL cada vez que finalice uno de los firmantes y cuando la solicitud llegue a un estado final. En este servicio que desarrolla el cliente es donde puede descargarse el documento firmado, guardar en su sistema información detallada (datos de un formulario, firmante, etc.) o el estado de la solicitud. Para mejorar la trazabilidad, el JSON dispone de un atributo externalCode que facilita la asociación entre solicitudes de ambos sistemas. También podrás consultar el estado de un callbackURL e incluso realizar un reenvío en caso de error.
La información detallada se encuentra en la siguiente URL:
https://doc.viafirma.com/documents/api/latest/es/response_set_callback.html
Almacenamiento del documento firmado
La última parte después de la creación de solicitudes y su seguimiento es el almacenamiento del documento firmado.
Viafirma Documents ofrece un complejo sistema para la persistencia de documentos firmados con posibilidad de alternar distintas configuraciones y procedimientos, así como la integración con repositorios de terceros para la transferencia de documentos firmados.
Viafirma cuenta con políticas de retención del documento donde un administrador puede establecer el tiempo de permanencia en nuestros sistemas y podrás optar por delegar el almacenamiento en nuestros sistemas y/o custodiar los documentos en un entorno propio (externo a Viafirma).
Para ello a través del servicio Callback de respuesta automática se recibirá una llamada con el JSON de la solicitud donde se indica el estado de la misma. Cuando el proceso ha finalizado correctamente será el momento de descargar los documentos que componen la solicitud de firma.
En el siguiente enlace se describe el proceso de llamada a la API:
https://doc.viafirma.com/documents/api/latest/es/download_signed_document.html
Para integraciones más avanzadas Viafirma Documents dispone de sistemas de transferencias que consisten en transferir automáticamente los documentos una vez finalizada la solicitud al gestor documental del cliente. Disponemos de implementaciones a medida para algunos clientes y otras genéricas como transferencias por FTP o Sharepoint.