Saltar al contenido principal

Opciones de firma en la API

Al enviar un documento para firmar mediante la API de Firma en la Nube, es posible configurar distintas opciones de firma que determinan la apariencia y ubicación de la firma dentro del documento PDF.

Estas opciones permiten adaptar la firma a los requerimientos visuales y funcionales de cada documento.


Configuración general

Las opciones de firma se envían junto con la solicitud de firma y permiten definir, entre otros aspectos:

  • La página en la que se insertará la firma
  • La posición exacta dentro de la página
  • El estilo visual de la firma
  • La escala de la firma respecto al documento

La correcta configuración de estos parámetros es clave para que la firma se visualice de la forma esperada.


Parámetros de ubicación

Los parámetros de ubicación controlan dónde se inserta la firma dentro del PDF:

  • page
    Número de página donde se aplicará la firma.

  • x / y
    Coordenadas dentro de la página que indican la posición exacta de la firma.

Estos valores permiten ubicar la firma en un área específica del documento.


Parámetros de estilo

Los parámetros de estilo permiten personalizar el aspecto visual de la firma:

  • fontName
    Tipografía utilizada para la firma.

  • fontSize
    Tamaño de la fuente.

  • fontColor
    Color del texto de la firma.

  • fontStyle
    Estilo de la fuente (por ejemplo, normal o destacado).

Estas opciones permiten que la firma se integre visualmente con el diseño del documento.


Escala de la firma

El parámetro zoomPercent define la escala de la firma respecto al tamaño original.

Este valor permite ajustar el tamaño final de la firma para asegurar su correcta visualización en el documento.


Otras opciones

Dependiendo del flujo de firma y del tipo de certificado, pueden existir opciones adicionales asociadas a:

  • Políticas aplicadas al certificado
  • Restricciones específicas del proceso de firma

Estas opciones se detallan en la documentación de referencia de la API.


Relación con el flujo de firma

Las opciones de firma forman parte del paso de envío del documento para firma y se combinan con:

  • El token de autenticación
  • El identificador de la solicitud
  • El documento a firmar

En la siguiente sección se presenta un ejemplo práctico end-to-end que muestra cómo aplicar estas opciones dentro de un flujo completo de firma.