Webhook de firma digital

El webhook de firmar.online informa de los eventos que propician cambios en el estado de los documentos, por lo que te permitirá realizar un seguimiento automatizado de cada uno de ellos. Cada vez que el documento enviado para su firma electrónica (DocumentSet) cambie de estado, firmar.online te informará de qué acción ha ocurrido para provocar este cambio de estado. Esta comunicación se realiza al instante por medio de una llamada http.

Aplica exclusivamente a los documentos procesados mediante las funciones de “enviar a firmar” y “firma presencial”. Es decir, cuando se quiere solicitar la firma electrónica de un documento a otra persona, ya sea en un proceso presencial o remoto (recuerda que la firma digital en servidor y la validación de la firma digital de documentos se realizan de forma síncrona. Por tanto, los documentos se devuelven automáticamente firmados. No tienen gestión de estados)

Puedes definir tu URL en el área de ajustes de la aplicación web.

Notificaciones “webhook” – firma digital

Las notificaciones se realizan en formato JSON

Un ejemplo de “nuevo sobre en la plataforma” sería el siguiente:

{"eventType": 101,"timestamp": "2021-09-22T10:14:30.7106693Z","data": {"documentSetToken": "8283524AF3C44AD3A43C295735050446"}}

Un ejemplo de “sobre completado” sería:

{"eventType": 102,"timestamp": "2022-02-23T09:10:58.3288864Z","data": {"documentSetId": "10380","numAttachments": "0","documentSetToken": "2CBD36556DBC4921BE0803F8101CF003","reference": "W2L|NIF|Nombre del firmante|TimeStamp"}}

La información enviada sería la siguiente:

eventType

Código tipo evento

integer

timestamp

Fecha evento

ISO 8601

data.recipientActionId

identificador interno persona documento

intenger

data.documentSetId

Identificador interno sobre

integer

data.numAttachments

Numero de ficheros adjuntados por el firmante

integer

data.documentSetToken

Identificador sobre

texto

data.motivoRechazo

Motivo rechazo sobre

texto

data.reference

Referencia externa sobre

texto

Las posibles acciones de las que informa el webhook, para firma remota, son las siguientes:

Evento

Descripción evento

Nuevo estado

Descripción estado

100

Documento creado

101

Sobre creado

200

En proceso

102

Sobre completado

300

Completado

103

Caducado

700

Caducado

104

Cancelado

400

Cancelado

105

Eliminado

600

Eliminado

106

Rechazado

500

Rechazado

107

Recordatorio enviado

200

En progreso

108

Error en el sobre

307

Firmado por uno de los participantes

1000

Descarga masiva creada

1001

Descarga masiva en proceso

1002

Descarga masiva completada

1003

Descarga masiva errónea

Política de reintentos

El webhook sigue una política de reintentos para asegurar que la información ha sido recibida de forma correcta.

Cada vez que el DocumentSet cambia de estado, firmar.online te informará de qué acción ha ocurrido para provocar este cambio de estado. Esta comunicación se realiza al instante por medio de una llamada http.

Si la llamada http devuelve el código 200 (OK), entendemos que se ha registrado correctamente y no se vuelve a enviar. En caso de no recibir ese código 200 (OK) de la llamada http, el webhook entra en una política de reintentos. Se volverá a tratar de informar del evento hasta tres veces.

Pasos para probar el webhook de firma digital

Puedes probar la funcionalidad y ver cómo llegan las respuestas en este portal web, https://webhook.site/ Para ello, tendrías que seguir los siguientes pasos:

1.- Acceder a https://webhook.site/

Verás que automáticamente te asigna una URL, con este formato https://webhook.site/#!/d0d83771-363c-4e09-aae0-6c8a447181cd

2.- Copia esta URL en la sección de Ajustes de la aplicación web. Funciona tanto en el entorno de producción (https://app.firmar.online) como en el de integraciones (https://app.firmar.info). Puedes configurar la misma URL de mismo webhook a los dos entornos.

3.- El la web https://webhook.site/ verás cómo se van reflejando las diferentes acciones realizadas en firmar.online

¿Cómo añadir usuario y contraseña del Webhook?

Se trata de enviar la información de autenticación en una cabecera de manera similar a como se hace en Postman o en webhook.site

Se añadiría a la configuración del Webhook y sería válido para todo tipo de autenticación.