Seguridad del API

Última revisión: 31 Mayo 2024

Los servicios del API de Viafirma Documents requieren seguridad, pudiendo optar por mecanismos Basic Authorization y OAuth v2.

Las credenciales son gestionadas por un Administrador desde el Panel de Control, opción Aplicaciones, teniendo en cuenta los siguientes criterios de configuración:

Configuración del API

Datos básicos

• Fecha de caducidad: una expirada el servicio consumido por estas credenciales devolverá un 401 similiar al error devuelto para credenciales no autorizadas.
• Plataforma: el uso del API por parte de terceros será fijada como tipo Sistema externo.
• Tipo de autenticación: a elegir entre los siguientes:
  • Basic Auth (aplicación)
  • OAuth2 (aplicación)
• Propietario: aunque un API puede ser autorizada por N grupos, solo uno de ellos actuará como dueño, por lo que el administrador o administradores de dicho grupo será quien pueda gestionar las propiedades.

Credenciales del API

El administrador del grupo y propietario del API podrá gestionar las credenciales acorde a sus políticas de seguridad.

Seguridad BasicAuth

Para este mecanismo de seguridad solo tendrás que tener en cuenta las credenciales user/pass previamente gestionadas desde el panel.

Seguridad OAuth2

Si vas a conectar tu sistema con el API de Viafirma haciendo uso de OAuth2 (application) como mecanismo de autenticación recuerda configurar correctamente el Grant Type en los ajustes de tu conexión. A continuación te dejamos algunas pautas de ejemplo en Postman.

Asegúrate de agregar los datos de conexión en el header:

Asegúrate que el Grant type esté configurado como Client Credential, para lo cual solo necesitarás las credenciales (Client ID / Client Secret) del API gestionada desde el Panel de Control de Viafimrma. Este tipo de uso del API NO REQUIERE credenciales de usuario final, es decir, nunca uses en este tipo de uso del API credenciales de usuario.

Otra configuración

Ciclo de vida de los procesos de firma

Los procesos de firma generados desde el API cuentan con una configuración específica acorde al ciclo de vida, pudiendo determinar el tiempo de retención de los procesos ya finalizados así como los documentos asociados a éstos.

También se podrá gestionar el plazo de firma establecido por defecto en todos los procesos gestionados desde este API, midiéndose en minutos. Por ejemplo, para un plazo de 72 horas se debe parametrizar un valor de 4320 minutos.

OAuth2 (end users)

A partir de la versión 3.7.88 de Viafirma Documents se incorpora un nuevo mecanismo de autenticación del API con OAuth2 (end users), reservado éste para apps de Viafirma, como los nuevos módulos de Bandeja y Compose, diseñados para interactuar directamente con el usuario previamente registrado, solicitando para ello sus credenciales nominales.

Si cuentas con un versión on-premises de Viafirma Documents este tipo de seguridad es la que debe usarse para configurar las apps de Viafirma. En caso de hacer uso de una versión cloud de Viafirma.