Mesclar documentos - Montagem de documentos API
PDF4me Mesclar documentos Permite combinar vários documentos do Word em um único documento com opções avançadas de formatação e conformidade. API O serviço processa vários arquivos do Word e os mescla com ordenação flexível de documentos, modos de formatação personalizáveis, configurações de nível de conformidade, metadados de fuso horário e gerenciamento inteligente de estilos. API recebe o conteúdo do documento através de REST API chamadas, utilizando Base64 Codificação para transmissão segura. Com suporte para mesclagem ilimitada de documentos e controle total sobre o comportamento da mesclagem, esta solução é ideal para montagem de documentos, consolidação de relatórios e fluxos de trabalho de gerenciamento de conteúdo.
Autenticando seu API Solicitar
Para acessar o PDF4me REST APIPara que uma solicitação seja aceita, é necessário incluir as credenciais de autenticação adequadas. A autenticação garante a segurança da comunicação e valida sua identidade como usuário autorizado do sistema. REST API.
Principais características
- Suporte a múltiplos documentosMesclar um número ilimitado de documentos em um só.
- Estrutura de matriz simplesConjunto de fácil utilização de Base64-conteúdo do documento codificado
- Fusão ordenadaDocumentos mesclados na ordem em que aparecem na matriz
- Conceito de documento baseO primeiro documento torna-se a base para a fusão.
- Suporte a múltiplos formatosMesclar documentos do Word, PDFs e outros formatos compatíveis.
REST API Ponto final
O PDF4me REST API usa padrão HTTP Métodos para interagir com recursos. Todas as operações de mesclagem de documentos são realizadas por meio de um único ponto de extremidade:
- Método: POST
- Ponto final:
office/ApiV2Word/MergeDocuments
REST API Parâmetros
Lista completa de parâmetros para a função Mesclar Documentos REST APIOs parâmetros estão organizados por categoria para melhor compreensão e implementação.
Importante: Os parâmetros marcados com um asterisco (*) são obrigatórios. documentos A matriz deve conter pelo menos um documento.
Parâmetros obrigatórios
| Parâmetro | Tipo | Descrição | Exemplo |
|---|---|---|---|
| documentos* | Array | Matriz de objetos de documento a serem mesclados. Deve conter pelo menos um documento. Cada objeto deve ter nome do arquivo (string) e conteúdo do documento (Base64 Os documentos são mesclados na ordem em que aparecem na matriz. Campos opcionais por documento: posição de classificação (inteiro), modo de formatação (corda) | [{ "filename": "doc1.docx", "docContent": "base64..." }, { "filename": "doc2.docx", "docContent": "base64..." }] |
Parâmetros opcionais
| Parâmetro | Tipo | Descrição | Exemplo |
|---|---|---|---|
| opções de mesclagem | Object | Opções de mesclagem (formatação, conformidade, etc.). Consulte o modelo de plugin para obter as propriedades disponíveis. | {} |
Ordem de Fusão de Documentos
Os documentos são mesclados na ordem em que aparecem no documentos variedade:
- O primeiro documento na matriz torna-se o documento base
- Todos os documentos subsequentes são acrescentado para o documento base em ordem de matriz
Saída
O PDF4me Mesclar documentos REST API Retorna respostas diferentes dependendo do modo de processamento. API retorna o documento Word como um Base64string codificada em JSON formato, não como dados binários.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Processamento síncrono (padrão)
O API processa a solicitação e retorna:
Código de status: 200 OK
Tipo de conteúdo: application/json
Corpo da resposta:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "merged-document.docx",
"success": true,
"errorMessage": null
}
Campos de resposta:
- documento (string): O documento Word mesclado contendo todos os documentos de entrada, codificado como Base64 corda
- nome_do_arquivo (string): O nome do arquivo Word de saída
- sucesso (booleano): Indica se a solicitação foi bem-sucedida.
- mensagem de erro (string ou nulo): Detalhes do erro quando o sucesso for falso
Como usar:
- Extraia o
documentcampo do JSON resposta (Base64) - Decifre o Base64 string para obter os dados binários do documento Word
- Salve ou processe o arquivo do Word conforme necessário.
Exemplo (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save or process wordBytes
Processamento assíncrono
Comportamento assíncrono (202 Accepted (com polling) é controlado pela configuração do servidor, não por um parâmetro no corpo da requisição. Quando habilitado, o API pode retornar um status 202 com uma pesquisa URL no Location cabeçalho. Consulte o URL com GET Faça solicitações até receber 200. OK com o mesmo formato de resposta (documento, nome do arquivo, sucesso, mensagem de erro).
Respostas de erro
O API retorna padrão HTTP Códigos de erro com detalhes do erro:
- Parâmetros de solicitação inválidos
- Campos obrigatórios ausentes (
documentosvariedade) - Nenhum documento para mesclar (matriz de documentos vazia)
- Inválido Base64 codificação no conteúdo do documento
- Documentos inválidos ou corrompidos
- Inválido ou ausente API chave
- API chave não está corretamente Base64 codificado em Authorization cabeçalho
- Ausente
Autorização: Básicacabeçalho
- Erro de processamento no servidor
- falha no processamento do documento Word
- Falha na fusão de documentos
Formato da resposta de erro:
{
"error": "Error message describing what went wrong"
}
Detalhes do formato da resposta
Importante: O API sempre retorna JSON, nunca dados binários do Word diretamente.
Estrutura da resposta:
{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": "string or null"
}
Cabeçalho Content-Type:
- Sucesso:
application/json - O documento do Word está incorporado como um Base64 string dentro do JSON resposta
Por que Base64?
- JSON-Codificação segura para dados binários
- Fácil de transmitir HTTP
- Compatível com todas as linguagens de programação.
- Pode ser incorporado diretamente em JSON sem escapar dos problemas
Decodificando Base64 Para documento do 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);
Exemplo de solicitação
Cabeçalho
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Observação:
- Adquira o seu API chave do PDF4me Painel
- O API a chave deve ser Base64 codificado e prefixado com "Básico" no Authorization cabeçalho
- Exemplo: Se o seu API chave é
abc123, codifique-o para Base64 e usarAuthorization: Basic YWJjMTIz
Carga útil
Exemplo básico (dois documentos):
{
"documents": [
{ "filename": "doc1.docx", "docContent": "base64EncodedDocument1" },
{ "filename": "doc2.docx", "docContent": "base64EncodedDocument2" }
]
}
Exemplo avançado (vários documentos com opções de mesclagem):
{
"documents": [
{ "filename": "doc1.docx", "docContent": "base64EncodedDocument1" },
{ "filename": "doc2.docx", "docContent": "base64EncodedDocument2" },
{ "filename": "doc3.docx", "docContent": "base64EncodedDocument3" }
],
"mergeOptions": {}
}
Exemplos de código
O PDF4me Mesclar documentos REST API Fornece exemplos de código em várias linguagens de programação. Escolha a linguagem que melhor se adapta ao seu ambiente de desenvolvimento:
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
Java Amostra
Java Implementação com tratamento completo de erros e processamento de respostas:
JavaScript Amostra
Node.js e compatível com navegadores JavaScript Implementação:
Google Script Amostra
Google Apps Script implementação para Google Workspace integração:
Casos de uso e aplicações industriais
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
Casos de uso de serviços jurídicos e profissionais
- Montagem de ContratoCombine as seções do contrato em documentos legais completos.
- Consolidação de documentos jurídicosConsolidar várias seções breves em documentos jurídicos abrangentes.
- Documentação de ConformidadeConsolidar documentos de conformidade para submissões regulatórias
- Montagem de Documentos do Cliente: Combine documentos específicos do cliente em pacotes completos
Casos de uso para empresas e negócios
- Assembleia de PropostasCombine as seções da proposta em propostas completas para o cliente.
- Consolidação de Material de MarketingConsolidar documentos de marketing para campanhas
- Apresentação de VendasCombine as seções da apresentação em apresentações completas.
- Montagem de entregáveis ao clienteConsolidar materiais específicos do cliente
Casos de uso em educação e pesquisa
- Relatório MédicoCombinar seções de relatórios médicos em relatórios completos de pacientes.
- Documentação do Protocolo: Consolidar seções de protocolos em protocolos médicos abrangentes
- Documentação de pesquisaConsolidar documentos de pesquisa para relatórios de estudo
- Montagem do Manual de ConformidadeCombinar documentos de conformidade na área da saúde
Casos de uso em finanças e bancos
- Assembleia de Relatórios FinanceirosConsolidar seções de relatórios financeiros em relatórios completos.
- Documentação de auditoriaConsolidar documentos de auditoria para relatórios de auditoria abrangentes.
- Consolidação OrçamentáriaCombinar seções orçamentárias de diferentes departamentos
- Assembleia de Arquivos RegulatóriosConsolidar documentos regulatórios para submissão.