Callback a aplicaciones terceras

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á el código del callback (definido previamente en el sistema) al cual Viafirma Inbox enviará las notificaciones de cambios sobre la petición creada. De este modo, cuando una acción sea realizada por un usuario (firma, visto bueno o rechazo) sobre la petición, Viafirma Inbox hará un GET HTTP o un POST HTTP (según esté configurado en el callback) notificando a la URL indicada en el mismo.

Por supuesto, sigue existiendo la forma antigua (aunque en desuso) de indicar directamente la URL de callback en la creación de la petición por servicio. Esta forma es menos potente debido a que este tipo de callback sólo puede ser de tipo GET HTTP y sin autenticación. Recomendamos usar la nueva opción de apuntar al código del callback (previamente definido en el sistema).

callback basado en un GET HTTP

Campos que se añadirán a la URL de los callbacks de tipo GET HTTP:

• action: Acción realizada sobre la petición. Los posibles valores son:
  • NUEVO: Creación de la petición.
  • 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.
  • CADUCADO: La petición ha caducado (para peticiones con fecha de caducidad).
  • 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”.

callback basado en un POST HTTP

Campos que contendrá el json enviado a la URL de los callbacks de tipo POST HTTP:

• publicAccessId: 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).
• action: Acción realizada sobre la petición. Los posibles valores son:
  • NEW: Creación de la petición.
  • SIGN: Un usuario ha firmado la petición.
  • APPROVAL: Un usuario ha dado un visto bueno a la petición.
  • REJECT: Un usuario ha rechazado la petición.
  • EXPIRE: La petición ha caducado (para peticiones con fecha de caducidad).
  • DELETE: Un usuario ha eliminado la petición.
• status: Estado de la petición en el momento del envío del callback. Los posibles valores son:
  • IN_PROCESS: Petición en proceso. Está pendiente de firmas/vistos buenos por algunos de los usuarios del flujo.
  • COMPLETED: Petición finalizada. Todas las firmas/vistos buenos realizadas.
  • REJECTED: Petición rechazada por algún usuario.
  • EXPIRED: Petición caducada. Se ha llegada a la fecha de caducidad definida sin que se realizaran todas las acciones de firma/visto bueno sobre la petición.

Ejemplo callback POST HTTP

{
  "publicAccessId": "string",
  "action": "string",
  "status": "string"
}