Saltar al contenido principal
PDF4me APIIntegracionesBase de conocimientosExtensionesProbador de APIBlog

Comparar documentos - Comparación de documentos API

PDF4me Comparar documentos Te permite comparar dos documentos de Word y realizar un seguimiento de los cambios con opciones de comparación completas. API El servicio procesa dos archivos de Word y genera un documento comparativo con seguimiento detallado de cambios, configuración de comparación personalizable, gestión de revisiones e informes comparativos profesionales. API recibe ambos contenidos del documento a través de REST API llamadas, utilizando Base64 Codificación para una transmisión segura. Con control total sobre el formato, la distinción entre mayúsculas y minúsculas, los comentarios, las tablas, los campos, las notas al pie, los cuadros de texto y los encabezados/pies de página, esta solución es ideal para la revisión de documentos, el control de versiones y los flujos de trabajo de edición colaborativa.

Entradas de blog relacionadas
Aún no hay ninguna entrada de blog sobre esta función; estará disponible próximamente.
Mientras tanto, echa un vistazo al blog de PDF4me para encontrar tutoriales y flujos de trabajo para todas las plataformas.
Visita el blog →

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.

Get your api Key

Características principales​

  • Comparación de documentos: Compara dos documentos de Word e identifica todas las diferencias.
  • Control de cambios: Generar documentos con cambios registrados que muestren las modificaciones.
  • Opciones personalizablesControla qué tipos de cambios rastrear o ignorar.
  • Gestión de revisiones: Limpiar las revisiones existentes antes de la comparación
  • Atribución del autorAsignar cambios a autores específicos para garantizar la responsabilidad.
  • Producción profesionalGenerar documentos de comparación limpios con seguimiento de revisiones
  • Compatibilidad con múltiples formatosComparar archivos .docx y .doc
  • Filtrado avanzado: Ignorar formato, cambios de mayúsculas y minúsculas, comentarios, tablas y más

REST API Punto final​

El PDF4me REST API utiliza estándar HTTP métodos para interactuar con los recursos. Todas las operaciones de comparación de documentos se realizan a través de un único punto final:

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

REST API Parámetros​

Lista completa de parámetros para la función Comparar 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 y deben proporcionarse para la API para que funcione correctamente.

Parámetros requeridos​

ParámetroTipoDescripciónEjemplo
primer documento*ObjectReferencia del primer documento (base). Debe contener Nombre (cadena): nombre del documento con extensión (.docx, .doc). Este documento sirve como base para la comparación.{ "Name": "original.docx" }
firstDocContent*Base64Base64-Contenido codificado del primer documento. Debe ser un documento de Word válido (formatos .docx, .doc).UEsDBBQABgAIAAAA...
segundo documento*ObjectReferencia del segundo documento (de comparación). Debe contener Nombre (cadena): nombre del documento con extensión (.docx, .doc). Este documento se compara con el primero.{ "Name": "modified.docx" }
segundoContenidoDoc*Base64Base64-Contenido codificado del segundo documento. Debe ser un documento de Word válido (formatos .docx o .doc).UEsDBBQABgAIAAAA...

Parámetros opcionales (Opciones de comparación)​

ParámetroTipoDescripciónEjemplo
opciones de comparaciónObjectConfiguración de comparación. Propiedades: ignorarFormato (booleano), ignorarCambiosDeMayúsculas (booleano), ignorarComentarios (booleano), ignorarTablas (booleano), ignorarCampos (booleano), ignorar notas al pie (booleano), ignorar cuadros de texto (booleano), ignorarEncabezadosYPieDePie (booleano), autor (cadena). Consulte las opciones de comparación a continuación.{ "ignoreFormatting": false, "author": "John Doe" }

Opciones de comparación​

El API Proporciona un control preciso sobre qué cambios se deben rastrear:

Opciones de contenido:​

  • ignorarFormatoCéntrese en el contenido del texto, ignore los cambios de estilo.
  • ignorarCambiosDeMayúsculasComparación que no distingue entre mayúsculas y minúsculas
  • ignorarComentarios: Excluir los cambios de comentarios de la comparación
  • ignorarTablasExcluir cambios en la estructura y el contenido de la tabla
  • ignorarCampos: Excluir las actualizaciones de campos (contenido que se actualiza automáticamente)

Opciones de elementos del documento:​

  • ignorar notas al pie: Excluir cambios en las notas al pie
  • ignorar cuadros de texto: Excluir cambios en el cuadro de texto
  • ignorarEncabezadosYPieDePie: Excluir cambios en el encabezado/pie de página

Atribución:​

  • autor: Establecer el nombre del autor para los cambios registrados en el documento de comparación.

Producción​

El PDF4me Comparar 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.

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

Campos de respuesta:

  • documento (cadena): El documento de Word con los cambios registrados que muestran todas las diferencias, codificado como Base64 cadena
  • Nombre del archivo (cadena): El nombre del archivo Word de salida con los resultados de la comparación.
  • é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:

  1. Extraer el document campo del JSON respuesta (Base64)
  2. Decodifica el Base64 cadena para obtener los datos binarios del documento de Word
  3. Abra el documento en Word para revisar los cambios registrados.
  4. Acepte o rechace los cambios 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 - document contains tracked changes

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 usar Authorization: Basic YWJjMTIz

Carga útil​

Ejemplo básico (solo campos obligatorios):

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

Ejemplo avanzado (con opciones de comparación):

{
 "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"
 }
}

Ejemplo de comparación basada únicamente en el contenido:

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

Ejemplos de código​

El PDF4me Comparar 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# (CSharp) Muestra

Completo C# Implementación para comparar documentos de Word:

Casos de uso y aplicaciones en la industria​

Casos de uso de servicios legales y profesionales

  • Revisión de contratos: Compare las versiones del contrato para identificar cambios y modificaciones.
  • Actualizaciones de documentos legales: Seguimiento de cambios en informes legales, acuerdos y documentos judiciales.
  • Monitoreo del cumplimiento: Compare los documentos de política para garantizar el cumplimiento normativo.
  • Revisión de documentos del cliente: Realizar un seguimiento de los cambios en los documentos legales dirigidos a los clientes.

Obtén ayuda​

Get Your API KeyAPI SamplesGetting Started