viafirma inbox :: manual de integración

Notificaciones

Las aplicaciones terceras que utilicen los servicios web de Viafirma Inbox podrán, por ejemplo, crear peticiones, consultar su estado, etc. Sin embargo, en algunas ocasiones no basta con que estas aplicaciones puedan consultar el estado de una petición, sino que se requiere que el sistema les notifique cualquier novedad sobre estas peticiones creadas desde el aplicativo externo.

Esto está permitido y contemplado en el API de la plataforma. A la hora de enviar una nueva petición al sistema, entre los datos que se solicita (si bien no es obligatorio) está la URL a la cual Viafirma Inbox enviará las notificaciones de cambios sobre la petición creada. De este modo, cuando una notificación sea modificada por otro usuario (firmada, rechazada o dado el visto bueno), Viafirma Inbox hará un GET HTTP sobre la url proporcionada a la que se le añadirán los siguientes campos en el query string de la operación:

  • action: acción realizada sobre la petición. Los posibles valores son:
    • NUEVO: Un borrador creado desde los servicios web ha sido enviado.
    • FIRMADO: Un usuario ha firmado la petición.
    • VISTOBUENO: Un usuario ha dado un visto bueno a la petición.
    • DEVUELTO: Un usuario ha rechazado la petición.
    • ELIMINADO: Un usuario ha eliminado la petición.
  • label: Identificador (Public access id) de la petición que ha sido modificada (este parámetro se devuelve entre otros cuando se crea una petición a través del API, e identifica de forma unívoca una petición).
  • finished: Este parámetro se enviará sólo en el caso de que la petición de la que se recibe la notificación ha finalizado. Su valor será siempre el mismo: “ok”.