Pular para o conteúdo principal
API PDF4meIntegraçõesBase de conhecimentoExtensõesTestador de APIBlog

Comparar documentos - Comparação de documentos API

PDF4me Comparar documentos Permite comparar dois documentos do Word e acompanhar as alterações com opções de comparação abrangentes. API O serviço processa dois arquivos do Word e gera um documento de comparação com rastreamento detalhado de alterações, configurações de comparação personalizáveis, gerenciamento de revisões e relatórios de comparação profissionais. API recebe ambos os conteúdos de documentos através de REST API chamadas, utilizando Base64 Codificação para transmissão segura. Com controle total sobre formatação, diferenciação entre maiúsculas e minúsculas, comentários, tabelas, campos, notas de rodapé, caixas de texto e cabeçalhos/rodapés, esta solução é ideal para revisão de documentos, controle de versões e fluxos de trabalho de edição colaborativa.

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.

Get your api Key

Principais características​

  • Comparação de DocumentosCompare dois documentos do Word e identifique todas as diferenças.
  • Controlar alteraçõesGere documentos com controle de alterações que mostrem as modificações.
  • Opções personalizáveisControle quais tipos de alterações devem ser rastreadas ou ignoradas.
  • Gestão de RevisõesLimpe as revisões existentes antes da comparação.
  • Atribuição de autoriaAtribua as alterações a autores específicos para fins de responsabilização.
  • Produção profissionalGere documentos de comparação claros com controle de revisões.
  • Suporte a múltiplos formatosComparar arquivos .docx e .doc
  • Filtragem AvançadaIgnorar formatação, alterações de maiúsculas e minúsculas, comentários, tabelas e muito mais.

REST API Ponto final​

O PDF4me REST API usa padrão HTTP Métodos para interagir com recursos. Todas as operações de comparação de documentos são realizadas por meio de um único ponto de extremidade:

  • Método: POST
  • Ponto final: office/ApiV2Word/CompareDocuments

REST API Parâmetros​

Lista completa de parâmetros para a comparação de 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 e devem ser fornecidos para o API para funcionar corretamente.

Parâmetros obrigatórios​

ParâmetroTipoDescriçãoExemplo
primeiroDocumento*ObjectPrimeira referência (base) ao documento. Deve conter Nome (string): nome do documento com extensão (.docx, .doc). Este documento serve como base para comparação.{ "Name": "original.docx" }
primeiroDocumentoConteúdo*Base64Base64Conteúdo codificado do primeiro documento. Deve ser um documento Word válido (formatos .docx, .doc)UEsDBBQABgAIAAAA...
segundoDocumento*ObjectSegunda referência a documento (de comparação). Deve conter Nome (string): nome do documento com extensão (.docx, .doc). Este documento é comparado com o primeiro{ "Name": "modified.docx" }
conteúdo do segundo documento*Base64Base64Conteúdo codificado do segundo documento. Deve ser um documento Word válido (formatos .docx, .doc)UEsDBBQABgAIAAAA...

Parâmetros opcionais (opções de comparação)​

ParâmetroTipoDescriçãoExemplo
opções de comparaçãoObjectConfigurações de comparação. Propriedades: ignorarFormatação (booleano), ignorarAlteraçõesCase (booleano), ignorarComentários (booleano), ignorarTabelas (booleano), ignorarCampos (booleano), ignorar notas de rodapé (booleano), ignorar caixas de texto (booleano), ignorarCabeçalhoseRodapés (booleano), autor (string). Consulte as opções de comparação abaixo.{ "ignoreFormatting": false, "author": "John Doe" }

Opções de comparação​

O API Oferece controle preciso sobre quais alterações devem ser monitoradas:

Opções de conteúdo:​

  • ignorarFormataçãoConcentre-se no conteúdo do texto, ignore as alterações de estilo.
  • ignorarAlteraçõesCaseComparação que ignora maiúsculas e minúsculas
  • ignorarComentáriosExcluir alterações de comentários da comparação
  • ignorarTabelasExcluir alterações na estrutura e no conteúdo da tabela
  • ignorarCamposExcluir atualizações de campos (conteúdo com atualização automática)

Opções de elementos do documento:​

  • ignorar notas de rodapéExcluir alterações nas notas de rodapé
  • ignorar caixas de textoExcluir alterações na caixa de texto
  • ignorarCabeçalhoseRodapésExcluir alterações de cabeçalho/rodapé

Atribuição:​

  • autorDefina o nome do autor para as alterações controladas no documento de comparação.

Saída​

O PDF4me Comparar 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": "comparison-result.docx",
"success": true,
"errorMessage": null
}

Campos de resposta:

  • documento (string): O documento do Word com alterações controladas mostrando todas as diferenças, codificado como Base64 corda
  • nome_do_arquivo (string): O nome do arquivo Word de saída com os resultados da comparação
  • 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. Abra o documento no Word para revisar as alterações controladas.
  4. Aceitar ou rejeitar alterações 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 - document contains tracked changes

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 (somente campos obrigatórios):

{
 "firstDocument": { "Name": "original.docx" },
 "firstDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "secondDocument": { "Name": "modified.docx" },
 "secondDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC..."
}

Exemplo avançado (com opções de comparação):

{
 "firstDocument": { "Name": "original.docx" },
 "firstDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "secondDocument": { "Name": "modified.docx" },
 "secondDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "comparisonOptions": {
 "ignoreFormatting": false,
 "ignoreCaseChanges": false,
 "ignoreComments": true,
 "ignoreTables": false,
 "ignoreFields": true,
 "ignoreFootnotes": false,
 "ignoreTextboxes": false,
 "ignoreHeadersAndFooters": false,
 "author": "Legal Review System"
 }
}

Exemplo de comparação somente de conteúdo:

{
 "firstDocument": { "Name": "original.docx" },
 "firstDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "secondDocument": { "Name": "modified.docx" },
 "secondDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
 "comparisonOptions": {
 "ignoreFormatting": true,
 "ignoreCaseChanges": true,
 "ignoreComments": true,
 "ignoreFields": true,
 "author": "Content Review"
 }
}

Exemplos de código​

O PDF4me Comparar 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) Exemplo

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

Casos de uso e aplicações industriais​

Casos de uso de serviços jurídicos e profissionais

  • Revisão de ContratoComparar versões do contrato para identificar alterações e modificações.
  • Atualizações de documentos legaisAcompanhar alterações em documentos jurídicos, contratos e processos judiciais.
  • Monitoramento de ConformidadeCompare os documentos de política para garantir a conformidade regulamentar.
  • Revisão de Documentos do ClienteAcompanhar as alterações em documentos jurídicos voltados para o cliente.

Obtenha ajuda​

Get Your API KeyAPI SamplesGetting Started