Combinar documentos - Ensamblaje de documentos API
PDF4me Combinar documentos Le permite combinar varios documentos de Word en un solo documento con opciones avanzadas de formato y cumplimiento. API El servicio procesa varios archivos de Word y los combina con un ordenamiento flexible de documentos, modos de formato personalizables, configuraciones de nivel de cumplimiento, metadatos de zona horaria y manejo inteligente de estilos. API recibe el contenido del documento a través de REST API llamadas, utilizando Base64 Codificación para una transmisión segura. Con soporte para la fusión ilimitada de documentos y control total sobre el comportamiento de la fusión, esta solución es ideal para flujos de trabajo de ensamblaje de documentos, consolidación de informes y gestión de contenido.
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 múltiples documentos: Combinar un número ilimitado de documentos en uno solo
- Estructura de matriz simple: Matriz de fácil uso de Base64-contenido del documento codificado
- Fusión ordenada: Documentos fusionados en el orden en que aparecen en la matriz
- Concepto del documento base: El primer documento se convierte en la base para la fusión
- Compatibilidad con múltiples formatos: Combinar documentos de Word, PDF y otros formatos compatibles.
REST API Punto final
El PDF4me REST API utiliza estándar HTTP métodos para interactuar con los recursos. Todas las operaciones de fusión de documentos se realizan a través de un único punto final:
- Método: POST
- Punto final:
office/ApiV2Word/MergeDocuments
REST API Parámetros
Lista completa de parámetros para la combinación de documentos 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. documentos El array debe contener al menos un documento.
Parámetros requeridos
| Parámetro | Tipo | Descripción | Ejemplo |
|---|---|---|---|
| documentos* | Array | Matriz de objetos de documento que se fusionarán. Debe contener al menos un documento. Cada objeto debe tener Nombre del archivo (cadena) y docContent (Base64 cadena). Los documentos se fusionan en el orden en que aparecen en la matriz. Campos opcionales por documento: ordenarPosición (entero), modo de formato (cadena) | [{ "filename": "doc1.docx", "docContent": "base64..." }, { "filename": "doc2.docx", "docContent": "base64..." }] |
Parámetros opcionales
| Parámetro | Tipo | Descripción | Ejemplo |
|---|---|---|---|
| opciones de fusión | Object | Opciones de fusión (formato, conformidad, etc.). Consulte el modelo del complemento para ver las propiedades disponibles. | {} |
Orden de fusión de documentos
Los documentos se fusionan en el orden en que aparecen en el documentos matriz:
- El primer documento en la matriz se convierte en el documento base
- Todos los documentos subsiguientes son adjunto al documento base en orden de matriz
Producción
El PDF4me Combinar documentos REST API devuelve diferentes respuestas según el modo de procesamiento. API devuelve el documento de Word como un Base64cadena codificada en JSON formato, no como datos binarios.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Procesamiento síncrono (predeterminado)
El API procesa la solicitud y devuelve:
Código de estado: 200 OK
Tipo de contenido: application/json
Cuerpo de la respuesta:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "merged-document.docx",
"success": true,
"errorMessage": null
}
Campos de respuesta:
- documento (cadena): El documento de Word combinado que contiene todos los documentos de entrada, codificado como Base64 cadena
- Nombre del archivo (cadena): El nombre del archivo Word de salida
- éxito (booleano): Indica si la solicitud se realizó correctamente.
- mensaje de error (cadena o nulo): Detalles del error cuando el éxito es falso.
Cómo usarlo:
- Extraer el
documentcampo del JSON respuesta (Base64) - Decodifica el Base64 cadena para obtener los datos binarios del documento de Word
- Guarde o procese el archivo de Word según sea necesario.
Ejemplo (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save or process wordBytes
Procesamiento asíncrono
Comportamiento asíncrono (202 Accepted con sondeo) se controla mediante la configuración del servidor, no mediante un parámetro del cuerpo de la solicitud. Cuando está habilitado, el API puede devolver un estado 202 con una encuesta URL en el Location encabezado. Sondear el URL con GET solicitudes hasta que reciba 200 OK con la misma estructura de respuesta (documento, nombre de archivo, éxito, mensaje de error).
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 (
documentosmatriz) - No hay documentos para fusionar (matriz de documentos vacía)
- Inválido Base64 codificación en el contenido del documento
- Documentos inválidos o dañados
- 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 combinar documentos
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:
{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": "string or 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("output.docx", 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 (dos documentos):
{
"documents": [
{ "filename": "doc1.docx", "docContent": "base64EncodedDocument1" },
{ "filename": "doc2.docx", "docContent": "base64EncodedDocument2" }
]
}
Ejemplo avanzado (varios documentos con opciones de combinación):
{
"documents": [
{ "filename": "doc1.docx", "docContent": "base64EncodedDocument1" },
{ "filename": "doc2.docx", "docContent": "base64EncodedDocument2" },
{ "filename": "doc3.docx", "docContent": "base64EncodedDocument3" }
],
"mergeOptions": {}
}
Ejemplos de código
El PDF4me Combinar documentos 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
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
- Ensamblaje de contratos: Combinar secciones de contratos en documentos legales completos
- Consolidación de informes legales: Combinar varias secciones breves en informes legales completos.
- Documentación de cumplimiento: Consolidar los documentos de cumplimiento para las presentaciones regulatorias.
- Recopilación de documentos del cliente: Combinar documentos específicos del cliente en paquetes completos
Casos de uso para empresas y negocios
- Ensamblaje de propuestas: Combinar secciones de la propuesta en propuestas completas para el cliente.
- Consolidación de materiales de marketingCombinar documentos de marketing para campañas
- Montaje de presentación de ventas: Combinar secciones de la presentación en presentaciones completas
- Ensamblaje de entregables para el clienteConsolidar los materiales específicos de cada cliente.
Casos de uso en educación e investigación
- Ensamblaje de informes médicos: Combinar secciones de informes médicos en informes completos de pacientes.
- Documentación del protocolo: Fusionar secciones de protocolo en protocolos médicos integrales
- Documentación de investigaciónConsolidar los documentos de investigación para los informes de estudio.
- Ensamblaje del manual de cumplimiento: Combinar documentos de cumplimiento de la normativa sanitaria
Casos de uso en finanzas y banca
- Recopilación de informes financieros: Combinar secciones de informes financieros en informes completos
- Documentación de auditoríaConsolidar los documentos de auditoría para obtener informes de auditoría completos.
- Consolidación presupuestaria: Combinar secciones presupuestarias de diferentes departamentos
- Asamblea de Presentación de Documentos Regulatorios: Combinar documentos regulatorios para su presentación