Agregar marca de agua de texto a Word - Marca de agua de texto API
PDF4me Agregar marca de agua de texto a Word le permite agregar marcas de agua de texto personalizables a documentos de Word con un control integral de estilo y posicionamiento. API El servicio procesa archivos de Word y agrega marcas de agua de texto con control total sobre el contenido del texto, la familia de fuentes, el tamaño de fuente, los colores, los ángulos de rotación, los ajustes preestablecidos de orientación y los niveles de transparencia. API recibe el contenido del documento de Word a través de REST API llamadas, utilizando Base64 Codificación para una transmisión segura. Con soporte para etiquetas de seguridad, elementos de marca, avisos de confidencialidad e indicadores de estado, esta solución es ideal para la seguridad de documentos, la protección de marca y los flujos de trabajo de indicación de estado.
Autenticando su API Pedido
Para acceder al PDF4me REST APICada solicitud debe incluir las credenciales de autenticación adecuadas. La autenticación garantiza una comunicación segura y valida su identidad como usuario autorizado del sistema. REST API.
Características principales
- Compatibilidad con marcas de agua de textoMarcas de agua de texto profesionales con cualquier contenido de texto personalizado.
- Personalización de fuentesControl total sobre la familia de fuentes, el nombre de la fuente y el tamaño de la fuente.
- Opciones de colorColores con nombre, códigos hexadecimales, valores RGB y compatibilidad con códigos hexadecimales de 3 dígitos.
- Control de rotaciónÁngulos de rotación personalizados (0-360°) o preajustes de orientación predefinidos.
- Opciones de transparenciaEfectos de marca de agua semitransparentes o totalmente opacos
- Dimensionamiento automático: Dimensionamiento inteligente basado en la longitud del texto y el tamaño de la fuente.
- Aplicación a nivel de documentoMarcas de agua aplicadas a todas las secciones y encabezados.
- Detrás de la colocación del texto: Marcas de agua situadas detrás del contenido del documento
REST API Punto final
El PDF4me REST API utiliza estándar HTTP métodos para interactuar con los recursos. Todas las operaciones de adición de marcas de agua de texto se realizan a través de un único punto final:
- Método: POST
- Punto final:
office/ApiV2Word/AddTextWatermark
REST API Parámetros
Lista completa de parámetros para la función Agregar marca de agua de texto a Word. REST APILos parámetros están organizados por categoría para una mejor comprensión e implementación.
Importante: Los parámetros marcados con un asterisco (*) son obligatorios y deben proporcionarse para la API para que funcione correctamente.
Parámetros requeridos
| Parámetro | Tipo | Descripción | Ejemplo |
|---|---|---|---|
| documento* | Object | Descripción del documento. Debe incluir Nombre (cadena): nombre del archivo de Word con extensión .docx | { "Name": "document.docx" } |
| docContent* | Base64 | Contenido del documento de Word codificado en Base64 | UEsDBBQABgAIAAAA... |
| texto de marca de agua* | String | Texto que se mostrará como marca de agua. Obligatorio: no puede ser nulo, vacío ni contener solo espacios en blanco. Ejemplos: "CONFIDENCIAL", "BORRADOR", "APROBADO". | CONFIDENTIAL |
Parámetros opcionales
| Parámetro | Tipo | Descripción | Ejemplo |
|---|---|---|---|
| familia de fuentes | String | Familia tipográfica para el texto de la marca de agua. Comunes: "Arial", "Calibri", "Times New Roman", "Helvetica". Predeterminada: "Arial". | Arial |
| tamaño de fuente | Number (doble) | Tamaño de fuente en puntos (de 1 a 1000). Predeterminado: 72 | 72 |
| color de fuente | String | Color del texto. Nombres: "Rojo", "Azul", "Gris". Hexadecimal: "#FF0000", "FF0000". RGB: "RGB(255,0,0)". Predeterminado: "#808080" | #FF0000 |
| semiTransparente | Boolean | Transparencia. true = opacidad 50%, false = 100% (predeterminado) | true |
| rotación | Number (doble) | Ángulo de rotación personalizado (0-360°). Predeterminado: 0 | 45 |
| nombre de fuente | String | Nombre de la fuente para el texto de la marca de agua | Arial |
| orientación | String | Orientación predefinida: Horizontal (0°), Vertical (90°), Diagonal (45°), Al revés (180°). Anula la rotación si se proporciona. | Diagonal |
| Nombre de la cultura | String | Código cultural (por ejemplo, "en-US", "de-DE", "fr-FR"). Predeterminado: nulo | en-US |
Opciones de orientación del texto
La orientación del texto de la marca de agua sigue esta prioridad de parámetros:
- orientación - Si se proporciona, utiliza un ángulo de orientación predefinido.
- rotación - Si no se proporciona la orientación, se utiliza un ángulo de rotación personalizado.
- Por defecto - Si no se proporciona ninguno, se utiliza 0° (horizontal).
Orientaciones predefinidas:
- Horizontal: 0° (predeterminado)
- Vertical: 90°
- Diagonal: 45°
- Al revés: 180°
Producción
El PDF4me Agregar marca de agua de texto a Word REST API devuelve un JSON respuesta (ApiV2WordApiCallRes). En caso de éxito, API devuelve el documento de Word como un Base64cadena codificada en el document campo, no como datos binarios.
- Success Response
- Error Responses
- Response Format Details
Respuesta de éxito
Código de estado: 200 OK
Tipo de contenido: application/json
Cuerpo de la respuesta:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "document.docx",
"success": true,
"errorMessage": null
}
Campos de respuesta:
- documento (cadena): El documento de Word con la marca de agua de texto aplicada, codificado como Base64
- Nombre del archivo (cadena): El nombre del archivo Word de salida
- éxito (booleano): Indica si la operación se realizó correctamente.
- mensaje de error (cadena): Mensaje de error si el éxito es falso; de lo contrario, nulo.
Cómo usarlo:
- Controlar
success; si es verdadero, extraiga eldocumentcampo del JSON respuesta - Decodifica el Base64 cadena para obtener los datos binarios del documento de Word
- Guarde o procese el archivo de Word usando
fileName
Ejemplo (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
if (!data.success) throw new Error(data.errorMessage);
const wordBytes = atob(data.document);
// Save or process wordBytes
Respuestas de error
El API devuelve estándar HTTP Códigos de error con detalles del error:
- Parámetros de solicitud no válidos
- Faltan campos obligatorios (
documento,docContent,texto de marca de agua) texto de marca de aguano puede ser nulo, vacío o solo espacio en blanco.- Inválido Base64 codificación en
docContent - Documento de Word no válido o dañado
- Tamaño de fuente no válido (debe estar entre 1 y 1000)
- Ángulo de rotación no válido
- Inválido o faltante API llave
- API La llave no funciona correctamente. Base64 codificado en Authorization encabezado
- Desaparecido
Autorización: Básicaencabezado
- Error de procesamiento del servidor
- Error en el procesamiento del documento de Word
- Error al añadir la marca de agua de texto
Formato de respuesta de error:
{
"error": "Error message describing what went wrong"
}
Detalles del formato de respuesta
Importante: El API siempre regresa JSON, nunca datos binarios de Word directamente.
Estructura de respuesta (ApiV2WordApiCallRes):
{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": null
}
Encabezado de tipo de contenido:
- Éxito:
application/json - El documento de Word está incrustado como un Base64 cadena dentro de la JSON respuesta
Por qué Base64¿
- JSON-Codificación segura para datos binarios
- Fácil de transmitir HTTP
- Compatible con todos los lenguajes de programación.
- Se puede integrar directamente en JSON sin escapar de los problemas
Decodificación Base64 al documento de Word:
JavaScript/Node.js:
const base64 = response.document;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js
Python:
import base64
word_bytes = base64.b64decode(response['document'])
with open('output.docx', 'wb') as f:
f.write(word_bytes)
C#:
byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes(response.fileName, wordBytes);
Ejemplo de solicitud
Encabezamiento
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Nota:
- Consigue tu API clave del PDF4me Panel
- El API La clave debe ser Base64 codificado y prefijado con "Basic" en el Authorization encabezado
- Ejemplo: Si su API La clave es
abc123, codificarlo a Base64 y usarAuthorization: Basic YWJjMTIz
Carga útil
Ejemplo básico (solo campos obligatorios):
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"watermarkText": "CONFIDENTIAL"
}
Ejemplo avanzado (con campos opcionales):
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"watermarkText": "CONFIDENTIAL",
"orientation": "Diagonal",
"fontFamily": "Arial",
"fontSize": 72,
"fontColor": "#FF0000",
"semiTransparent": true,
"cultureName": "en-US"
}
Ejemplo de rotación personalizada:
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"watermarkText": "DRAFT",
"fontFamily": "Times New Roman",
"fontSize": 48,
"fontColor": "Gray",
"rotation": 45,
"semiTransparent": true
}
Ejemplos de código
El PDF4me Agregar marca de agua de texto a Word REST API Proporciona ejemplos de código en varios lenguajes de programación. Elija el lenguaje que mejor se adapte a su entorno de desarrollo:
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
C# (CSharp) Muestra
Completo C# Implementación para agregar marcas de agua de texto a documentos de Word:
Java Muestra
Java Implementación con manejo completo de errores y procesamiento de respuestas:
JavaScript Muestra
Node.js y compatible con navegadores JavaScript implementación:
Google Script Muestra
Google Apps Script implementación para Google Workspace integración:
Casos de uso y aplicaciones en la industria
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
Casos de uso de servicios legales y profesionales
- Documentos confidenciales: Marca de agua en documentos legales con avisos de "CONFIDENCIAL"
- Borradores de contratos: Marcar los borradores de acuerdos con el estado "BORRADOR - EN REVISIÓN"
- Etiquetas de privilegioAplicar marcas de agua con el texto "PRIVILEGIA ABOGADO-CLIENTE"
- Indicadores de estado: Indicar el estado "APROBADO" o "PENDIENTE DE REVISIÓN"
Casos de uso para empresas y negocios
- Hojas de precios: Añadir marcas de agua con el texto "PRECIOS CONFIDENCIALES" a las tarjetas de precios.
- Propuestas: Marca de agua en las propuestas de los clientes con avisos "© 2024 [Empresa]"
- Informes internos: Marcar los análisis internos con "SOLO PARA USO INTERNO"
- Borrador de materiales: Indicar estado "BORRADOR - NO PARA DISTRIBUCIÓN"
Casos de uso en educación e investigación
- Datos del paciente: Agregar marcas de agua con el texto "HIPAA PROTECTED" a los registros de pacientes.
- Informes médicosResultados de laboratorio con marca de agua y avisos de "INFORMACIÓN MÉDICA CONFIDENCIAL"
- Datos de investigaciónAplicar marcas de agua con el texto "DATOS DE INVESTIGACIÓN - CONFIDENCIALES"
- Reclamaciones de seguros: Marque los documentos de seguro con etiquetas que indiquen "PRIVACIDAD PROTEGIDA".
Casos de uso en finanzas y banca
- Seguridad de los estados financieros: Agregar marcas de agua con el texto "CONFIDENCIAL" a los informes financieros
- Proyectos de presupuesto: Borrador de documentos presupuestarios con marca de agua y estado "BORRADOR"
- Documentos de auditoríaAplicar marcas de agua de texto "COPIA DE AUDITORÍA" a los entregables de auditoría.
- Informes de clientes: Agregar marcas de agua de texto "© 2024 [Empresa]" a los informes dirigidos a los clientes.