Pular para o conteúdo principal

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.

Artigos relacionados no blogue
Ainda não há nenhuma publicação no blogue sobre esta funcionalidade — em breve.
Entretanto, explore o blogue da PDF4me para encontrar tutoriais e fluxos de trabalho para todas as plataformas.
Visite o blogue

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âmetroTipoDescriçãoExemplo
documentos*ArrayMatriz 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âmetroTipoDescriçãoExemplo
opções de mesclagemObjectOpçõ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.

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:

  1. Extraia o document campo do JSON resposta (Base64)
  2. Decifre o Base64 string para obter os dados binários do documento Word
  3. 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

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 usar Authorization: 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# (CSharp) Amostra

Completo C# Implementação para mesclar documentos do Word:

Casos de uso e aplicações industriais

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

Obtenha ajuda