Estructura página de firma web

Última revisión: 06 Marzo 2023

Viafirma Documents permite la personalización del logo y colores, así como ocultar/mostrar algunos elementos y componentes.

Para ello, puedes subir un archivo en formato JSON en el apartado Estilos, dentro del backend. En concreto, en la sección con título: Estilos de la pantalla de firma o acceso a aplicaciones (JSON).

Puedes descargarte el JSON de ejemplo desde este enlace.

No es necesario que se incluyan todos los valores. Solo se sobreescribirán aquellos que se incluyan en el archivo JSON. En la mayoría de casos, con incluir los valores de logo y mainColor es suficiente.

ATENCIÓN
Asegúrate de que, insertes los valores que insertes, el último valor no esté seguido de una `,` ya que es un error muy común y esto provoca que el JSON sea inválido.

A continuación, vamos a detallar todas las posibilidades de personalización que se permiten:

Parámetros generales

logo

Por defecto: URL logo de Viafirma. Toma como valor la URL del logotipo.

avoidGeolocation

Por defecto: false. Al activarlo, NO se pedirá la localización del dispositivo. Aquí te explicamos más detalles.

hideDocumentBeforeStart

Por defecto: false. Se oculta el paso inicial de vista previa del documento.

hideDownloadDocumentBeforeStart

Por defecto: false. Cuando está a true desaparece el botón de descargar documento en la barra azul superior del paso "Previsualizar documento"

hideRejectAction

Por defecto: false. Se oculta el botón 'Rechazar'.

hideOpenInApp

Por defecto: true. Se oculta el botón que permite continuar la solicitud en la APP.

hideIntro

Por defecto: false. Se oculta la primera pantalla de la solicitud.

hideAuditTrailLink

Por defecto: false. Se oculta la el botón que permite ver el detalle de la solicitud al finalizar la petición y por tanto no podrá tampoco descargar el PDF firmado.

showUploadSignature

Por defecto: false. Se muestra el enlace que permite subir una imagen en la pantalla de firma biométrica.

languageId

Por defecto: es. Permite indicar el idioma en el que se desea mostrar la página de firma para el grupo asociado.

hideSidebar

Por defecto: false. Se oculta el sidebar de la izquierda en pantalla de la solicitud. Útil para embeber la página de firma en un iframe.

hideHeader

Por defecto: false. Se oculta la barra superior en pantalla de la solicitud. Útil para embeber la página de firma en un iframe.

favicon

Por defecto: ``. Permite indicar el favicon concreto para la página de firma.

tabTitle

Por defecto: .... Permite indicar el título de la página de firma que se muestra en el navegador (ventana o pestaña).

panelAttachmentsFirst

Por defecto: false. En la sidebar de la página de firma, los adjuntos se muestran antes que las evidencias en el listado de pasos de una petición

hideImageUpload

Por defecto: false. Permite ocultar la opción de subir imagen para las evidencias de tipo IMAGE y para los adjuntos de tipo IMAGEN e IMAGEN/PDF.

hideImageCapture

Por defecto: false. Permite ocultar la opción de hacer captura con cámara para las evidencias de tipo IMAGE y para los adjuntos de tipo IMAGEN e IMAGEN/PDF.

allowedSignType

Por defecto, si no se completa este valor, las solicitudes en espera de firma cliente tendrán las opciones CLIENT (Firma con certificado).

Los valores que se pueden indicar separados por comas (' ,' ) son:

• CLIENT. Es la opción por defecto. Firma con certificado desde Viafirma Documents Desktop (Windows y MacOS) o con las apps móviles.
• FORTRESS. Firma con certificado centralizado con Viafirma Fortress. Los usuarios podrán hacer uso de su certificado en la nube para firmar.
• OTP_SMS. Firma mediante evidencia OTP-SMS al teléfono del usuario.
• OTP_MAIL. Firma mediante evidencia OTP-MAIL al correo del usuario.
• ANDES_CA. Firma con certificado centralizado con ANDES CA (Colombia).

showDescriptionUnderChecks

Por defecto: false. Permite que la descripción de un grupo de checks aparezca debajo de ellos, en vez de arriba.

hideMessageDetailSidebar

Por defecto: false. Cuando está a true deshabilita el comportamiento actual en la página final de mostrar una barra lateral de detalle al clicar sobre un elemento. En su lugar se abrirá una nueva pestaña con la auditoría del documento clicado.

Colores

mainColor

Color corporativo principal. Por defecto: #0062BE (azul).

headerBackgroundColor

Color de fondo de la cabecera. Por defecto: #ffffff (blanco).

headerTextColor

Color del texto de la cabecera. Por defecto: #333333 (negro).

ATENCIÓN
Si una vez subido el JSON, pruebas una solicitud de firma y no ves los cambios aplicados, prueba a borrar la caché o en una ventana de incógnito de tu navegador

otpSMSSignatureStamperText

Texto que se pondrá en los sellos de firma, cuando se haga una firma con OTP SMS

otpMailSignatureStamperText

Texto que se pondrá en los sellos de firma, cuando se haga una firma con OTP MAIL