beta

Agregar marcas de agua a documentos PDF

🤖/document/watermark agrega marcas de agua de texto personalizadas a cada página de un PDF.

Agrega texto a cada página de un PDF existente y conserva el contenido original de cada página como contenido PDF. El texto seleccionable existente sigue siendo seleccionable. Se conservan los tamaños de página, los cuadros de recorte y la rotación de las páginas.

El texto se incorpora al contenido de la página. Esto proporciona una marca de agua visible, pero no protección contra copias ni supresión de contenido.

Posicionamiento por coordenadas

Usa x_offset y y_offset para mover la marca de agua con respecto a position, como los desplazamientos de la marca de agua en /image/resize y /video/encode. Los desplazamientos utilizan puntos PDF en lugar de píxeles y admiten valores fraccionarios. Se aplican después de ajustar el texto; los desplazamientos que sitúan el texto fuera de la página visible pueden hacer que se recorte.

Para usar coordenadas medidas desde la esquina superior izquierda de la página visible, establece position: "top-left", margin: 0 y rotation: 0. Por ejemplo, estos ajustes sitúan el cuadro delimitador de la marca de agua a 72 puntos del borde izquierdo y a 144 puntos del borde superior en cada página, incluidas las páginas rotadas y recortadas:

{
  "robot": "/document/watermark",
  "use": ":original",
  "text": "Licensed to ${fields.name}",
  "position": "top-left",
  "margin": 0,
  "rotation": 0,
  "x_offset": 72,
  "y_offset": 144
}

Solo se admiten archivos PDF sin cifrar. Modificar un PDF firmado digitalmente invalida sus firmas existentes. Este Robot no conserva la conformidad con PDF/A ni la certificación del documento.

Ejemplo de uso

Coloca texto específico de la solicitud en cada página de un PDF:

{
  "steps": {
    "watermarked": {
      "robot": "/document/watermark",
      "text": "${fields.watermark}",
      "use": ":original"
    }
  }
}

Parámetros

interpolate
boolean | Record<string, boolean>
Controla si las Assembly Variables se interpolan en campos de instrucciones individuales.

De forma predeterminada, la mayoría de los campos de instrucciones de los Robots interpolan Assembly Variables. Establece esta opción en false para tratar todos los campos de instrucciones como texto literal, o establece la ruta de un campo individual en false para tratar únicamente ese campo como texto literal. En el caso de los campos específicos de un Robot que son literales de forma predeterminada, establece esta opción en true o la ruta de ese campo en true para volver a habilitar la interpolación.

Usa nombres de campos como path o rutas con puntos como ffmpeg.vf para los objetos anidados.
output_meta
Record<string, boolean> | boolean | Array<string>
Te permite especificar un conjunto de metadatos cuyo cálculo requiere más recursos de CPU y que, por lo tanto, está desactivado de forma predeterminada para mantener el procesamiento de tus Assemblies rápido.

Para imágenes, puedes añadir "has_transparency": true en este objeto para extraer si la imagen contiene partes transparentes y "dominant_colors": true para extraer un array de códigos de color hexadecimales de la imagen.

Para imágenes, también puedes añadir "blurhash": true para extraer una cadena BlurHash, una representación compacta de un marcador de posición para la imagen que resulta útil para mostrar una vista previa desenfocada mientras se carga la imagen completa.

Para imágenes, "thumbhash": true extrae en su lugar un ThumbHash codificado en base64 en meta.thumbhash, junto con meta.has_alpha (si existe un canal alfa, incluso cuando es totalmente opaco). Describe píxeles orientados según EXIF y usa el primer fotograma en el caso de imágenes animadas. La extracción se realiza según el mejor esfuerzo posible: las imágenes de más de 40 megapíxeles, los formatos no compatibles o una decodificación fallida o limitada no generan ningún marcador de posición. Una extracción exitosa añade un cargo de metadatos equivalente al 20 % de los bytes de ese archivo. No se aplica ningún recargo por ThumbHash cuando está desactivado o cuando no se genera ningún hash.

Configura esta opción en el Step que genera la imagen, como /upload/handle para los originales subidos o /image/resize para las salidas procesadas. Configurarla únicamente en /transloadit/store no solicita la extracción: el almacenamiento conserva los metadatos del Step que generó la imagen. Transloadit Storage conserva un hash generado junto con su versión inmutable y lo devuelve en los resultados almacenados y en las lecturas nativas de activos. Las subidas directas a S3 no generan marcadores de posición. Un marcador de posición contiene información de la imagen, por lo que debes protegerlo con los mismos controles de acceso que la imagen completa.

Para videos, puedes añadir el parámetro "colorspace": true para extraer el espacio de color del video de salida.

Para videos, también puedes añadir "interlaced": true para detectar si el video está entrelazado. Esto combina el indicador field_order de ffprobe, cuyo costo computacional es bajo, con una pasada de muestreo limitada mediante idet sobre los primeros fotogramas de la fuente, y expone interlaced, field_order y un objeto de diagnóstico interlace_detection en file.meta. Esto requiere muchos recursos computacionales y se factura en consecuencia.

Para audio, puedes añadir "mean_volume": true para obtener un único valor que represente el volumen promedio del archivo de audio.

También puedes establecer esto en false para omitir la extracción de metadatos y acelerar la transcodificación.
user_meta
Record<string, any>(valor predeterminado: {})
Añade metadatos JSON personalizados a cada archivo emitido sin modificar su contenido. Se admiten objetos y arrays anidados.

La herencia depende del Robot. Los valores se combinan con los user_meta existentes en el archivo de salida; el Step actual reemplaza las claves coincidentes de nivel superior. Asigna explícitamente las claves necesarias cuando un Robot cree nuevos archivos de salida.

En los Steps de procesamiento, ${file.*} hace referencia a la primera entrada y ${result.*} al archivo emitido. Los valores se evalúan para cada salida después de ejecutarse el Robot, antes de la posterior extracción de metadatos y del almacenamiento temporal. En :original, los valores se evalúan para cada subida antes de la extracción de metadatos.

Los Steps posteriores leen ${file.user_meta.key}. Consulta Metadatos personalizados para ver un ejemplo completo y las reglas de herencia.
result
boolean(valor predeterminado: false)
Indica si los resultados de este Step deben aparecer en el Assembly Status JSON
queue
batch
Establecer la cola en «batch» reduce manualmente la prioridad de los Jobs de este Step para evitar consumir cupos prioritarios con Jobs que no necesitan un tiempo de espera cero en la cola
force_accept
boolean(valor predeterminado: false)
Forzar a un Robot a aceptar un tipo de archivo que habría ignorado.

De forma predeterminada, los Robots ignoran los archivos que no reconocen. 🤖/video/encode, por ejemplo, ignorará sin problemas las imágenes de entrada.

Si configuras el parámetro force_accept como true, puedes forzar a los Robots a aceptar todos los archivos que reciban. Esto normalmente provocará errores y solo debe usarse para depuración o para abordar casos extremos.
ignore_errors
boolean | Array<meta | execute>(valor predeterminado: [])
Ignorar errores durante fases específicas del procesamiento.

Establecer este parámetro en ["meta"] hará que el Robot ignore los errores durante la extracción de metadatos.

Establecer este parámetro en ["execute"] hará que el Robot ignore los errores durante la fase principal de ejecución.

Configurar este parámetro como true equivale a ["meta", "execute"] y hará que se ignoren los errores en ambas fases.
use
string | Array<string> | Array<object> | object
Especifica qué Step o Steps se usarán como entrada.
- Puedes elegir cualquier nombre para los Steps, excepto ":original" (reservado para las subidas de usuarios gestionadas por Transloadit)
- Puedes proporcionar varios Steps como entrada mediante arrays:
```
{
  "use": [
    ":original",
    "encoded",
    "resized"
  ]
}
```
- También puedes etiquetar los Steps de entrada con as para comunicar la intención semántica a los Robots:
```
{
  "use": [
    {
      "name": ":original",
      "as": "image"
    },
    {
      "name": ":original",
      "as": "mask"
    }
  ]
}
```
Consejo

Probablemente eso sea todo lo que necesitas saber sobre use, pero puedes consultar los casos de uso avanzados.
text — obligatorio
string
El texto que se colocará en cada página. Usa Assembly Variables como ${fields.watermark} para personalizar cada solicitud. Los saltos de línea crean varias líneas de texto. Los caracteres deben estar disponibles en la fuente seleccionada; los caracteres no compatibles producen un error.
font
DejaVu Sans | DejaVu Serif | DejaVu Sans Mono(valor predeterminado: "DejaVu Sans")
La fuente incrustada que se usa para la marca de agua.
font_size
string | number(valor predeterminado: 36)
El tamaño máximo de la fuente, en puntos PDF. El texto se reduce para caber dentro de los márgenes de la página.
color
string(valor predeterminado: "#808080")
El color de la marca de agua como valor RGB hexadecimal de seis dígitos.
opacity
string | number(valor predeterminado: 0.25)
La opacidad de la marca de agua, desde 0 (completamente transparente) hasta 1 (completamente opaca).
position
bottom | bottom-left | bottom-right | center | left | right | top | (valor predeterminado: "center")
La posición dentro de la página visible, teniendo en cuenta la rotación y el recorte de la página.
x_offset
string | number(valor predeterminado: 0)
Desplazamiento horizontal respecto de position, en puntos PDF (72 puntos = 1 pulgada). Los valores positivos desplazan la marca de agua hacia la derecha, salvo en las posiciones alineadas a la derecha, en las que la desplazan hacia la izquierda. Los valores negativos invierten esa dirección. Los desplazamientos siguen los ejes de la página visible, independientemente de la rotación del texto.
y_offset
string | number(valor predeterminado: 0)
Desplazamiento vertical respecto de position, en puntos PDF (72 puntos = 1 pulgada). Los valores positivos desplazan la marca de agua hacia abajo, salvo en las posiciones alineadas al borde inferior, en las que la desplazan hacia arriba. Los valores negativos invierten esa dirección. Los desplazamientos siguen los ejes de la página visible, independientemente de la rotación del texto.
rotation
string | number(valor predeterminado: 45)
La rotación del texto en grados, en sentido contrario a las agujas del reloj y con respecto a la página visible.
margin
string | number(valor predeterminado: 24)
El margen interior respecto de los bordes visibles de la página, en puntos PDF, que se utiliza para posicionar y ajustar la marca de agua antes de aplicar x_offset y y_offset.

Agregar marcas de agua a documentos PDF

Posicionamiento por coordenadas

Ejemplo de uso

Parámetros

`interpolate`

`output_meta`

`user_meta`

`result`

`queue`

`force_accept`

`ignore_errors`

`use`

`text` — obligatorio

`font`

`font_size`

`color`

`opacity`

`position`

`x_offset`

`y_offset`

`rotation`

`margin`

Agregar marcas de agua a documentos PDF

Posicionamiento por coordenadas

Ejemplo de uso

Parámetros

interpolate

output_meta

user_meta

result

queue

force_accept

ignore_errors

use

text — obligatorio

font

font_size

color

opacity

position

x_offset

y_offset

rotation

margin

`interpolate`

`output_meta`

`user_meta`

`result`

`queue`

`force_accept`

`ignore_errors`

`use`

`text` — obligatorio

`font`

`font_size`

`color`

`opacity`

`position`

`x_offset`

`y_offset`

`rotation`

`margin`