Aller au contenu principal
API PDF4meIntégrationsBase de connaissancesExtensionsTesteur d'APIBlog

Comparer des documents - Comparaison de documents API

PDF4me Comparer les documents vous permet de comparer deux documents Word et de suivre les modifications grâce à des options de comparaison complètes. API Ce service traite deux fichiers Word et génère un document de comparaison avec un suivi détaillé des modifications, des paramètres de comparaison personnalisables, une gestion des révisions et des rapports de comparaison professionnels. API reçoit le contenu des deux documents via REST API appels, utilisant Base64 Encodage pour une transmission sécurisée. Grâce à un contrôle total sur la mise en forme, la sensibilité à la casse, les commentaires, les tableaux, les champs, les notes de bas de page, les zones de texte et les en-têtes/pieds de page, cette solution est idéale pour la révision de documents, le contrôle de version et les flux de travail d'édition collaborative.

Articles de blog connexes
Il n'y a pas encore d'article de blog consacré à cette fonctionnalité — à venir prochainement.
En attendant, n'hésitez pas à consulter le blog de PDF4me pour découvrir des tutoriels et des procédures de travail adaptés à toutes les plateformes.
Consultez le blog →

Authentification de votre API Demande​

Pour accéder au PDF4me REST APIChaque requête doit inclure des informations d'authentification valides. L'authentification garantit la sécurité des communications et confirme votre identité en tant qu'utilisateur autorisé. REST API.

Get your api Key

Caractéristiques principales​

  • Comparaison de documentsComparez deux documents Word et identifiez toutes les différences.
  • Suivre les modificationsGénérer des documents avec suivi des modifications montrant les modifications
  • Options personnalisables: Contrôlez les types de modifications à suivre ou à ignorer
  • Gestion des révisionsNettoyer les révisions existantes avant la comparaison
  • Attribution de l'auteurAttribuer les modifications à des auteurs spécifiques pour en assurer la responsabilité
  • Production professionnelleGénérer des documents de comparaison clairs avec suivi des révisions
  • Prise en charge de plusieurs formats: Comparer les fichiers .docx et .doc
  • Filtrage avancéIgnorer la mise en forme, les changements de casse, les commentaires, les tableaux, etc.

REST API Point de terminaison​

Le PDF4me REST API utilise la norme HTTP méthodes d'interaction avec les ressources. Toutes les opérations de comparaison de documents sont effectuées via un point de terminaison unique :

  • Méthode: POST
  • Point final : office/ApiV2Word/CompareDocuments

REST API Paramètres​

Liste complète des paramètres pour la comparaison de documents REST APILes paramètres sont organisés par catégorie pour une meilleure compréhension et une mise en œuvre plus aisée.

Important: Les paramètres marqués d'un astérisque (*) sont obligatoires et doivent être fournis pour le API pour fonctionner correctement.

Paramètres requis​

ParamètreTaperDescriptionExemple
premierDocument*ObjectPremière référence (document de base). Doit contenir Nom (chaîne de caractères) : nom du document avec son extension (.docx, .doc). Ce document sert de base à la comparaison.{ "Name": "original.docx" }
premierDocContenu*Base64Base64Contenu encodé du premier document. Doit être un document Word valide (formats .docx ou .doc).UEsDBBQABgAIAAAA...
deuxièmeDocument*ObjectDeuxième référence de document (comparatif). Doit contenir Nom (chaîne de caractères) : nom du document avec son extension (.docx, .doc). Ce document est comparé au premier.{ "Name": "modified.docx" }
secondDocContent*Base64Base64- Contenu encodé du deuxième document. Doit être un document Word valide (formats .docx ou .doc).UEsDBBQABgAIAAAA...

Paramètres optionnels (options de comparaison)​

ParamètreTaperDescriptionExemple
options de comparaisonObjectParamètres de comparaison. Propriétés : ignorer la mise en forme (booléen), ignorer les changements de casse (booléen), ignorer les commentaires (booléen), ignorer les tableaux (booléen), ignorer les champs (booléen), ignorer les notes de bas de page (booléen), ignorer les boîtes de texte (booléen), ignorer les en-têtes et les pieds de page (booléen), auteur (chaîne de caractères). Voir les options de comparaison ci-dessous.{ "ignoreFormatting": false, "author": "John Doe" }

Options de comparaison​

Le API offre un contrôle précis sur les modifications à suivre :

Options de contenu :​

  • ignorer la mise en formeConcentrez-vous sur le contenu textuel, ignorez les modifications de style
  • ignorer les changements de casse: Comparaison insensible à la casse
  • ignorer les commentairesExclure les modifications de commentaires de la comparaison
  • ignorer les tableauxExclure les modifications de la structure et du contenu du tableau
  • ignorer les champs: Exclure les mises à jour de champs (contenu à mise à jour automatique)

Options des éléments de document :​

  • ignorer les notes de bas de pageExclure les modifications des notes de bas de page
  • ignorer les boîtes de texteExclure les modifications de la zone de texte
  • ignorer les en-têtes et les pieds de pageExclure les modifications d'en-tête/de pied de page

Attribution:​

  • auteur: Indiquez le nom de l'auteur des modifications suivies dans le document de comparaison

Sortir​

Le PDF4me Comparer les documents REST API renvoie des réponses différentes selon le mode de traitement. API renvoie le document Word sous forme de Base64chaîne encodée dans JSON format, et non sous forme de données binaires.

Traitement synchrone (par défaut)

Le API traite la requête et renvoie :

Code d'état : 200 OK

Type de contenu : application/json

Corps de la réponse :

{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "comparison-result.docx",
"success": true,
"errorMessage": null
}

Champs de réponse :

  • document (chaîne de caractères) : Le document Word avec suivi des modifications affichant toutes les différences, encodé comme Base64 chaîne
  • nom de fichier (chaîne de caractères) : Nom du fichier Word de sortie contenant les résultats de la comparaison
  • succès (booléen) : Indique si la requête a abouti.
  • message d'erreur (chaîne de caractères ou null) : Détails de l’erreur en cas d’échec

Mode d'emploi :

  1. Extraire le document champ du JSON réponse (Base64)
  2. Décodez le Base64 chaîne permettant d'obtenir les données binaires d'un document Word
  3. Ouvrez le document dans Word pour consulter les modifications suivies.
  4. Accepter ou refuser les modifications selon les besoins

Exemple (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

Exemple de requête​

En-tête​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Note:

  • Obtenez votre API clé de la PDF4me Tableau de bord
  • Le API La clé doit être Base64 encodé et préfixé par « Basic » dans le Authorization en-tête
  • Exemple : Si votre API La clé est abc123, encodez-le en Base64 et utiliser Authorization: Basic YWJjMTIz

Charge utile​

Exemple simple (champs obligatoires uniquement) :

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

Exemple avancé (avec options de comparaison) :

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

Exemple de comparaison de contenu uniquement :

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

Exemples de code​

Le PDF4me Comparer les documents REST API propose des exemples de code dans plusieurs langages de programmation. Choisissez le langage qui convient le mieux à votre environnement de développement :

C# Exemple (CSharp)

Complet C# implémentation pour la comparaison de documents Word :

Cas d'utilisation et applications industrielles​

Cas d'utilisation des services juridiques et professionnels

  • Examen des contrats: Comparer les versions du contrat pour identifier les changements et les modifications
  • Mises à jour des documents juridiquesSuivre les modifications apportées aux mémoires juridiques, aux accords et aux documents judiciaires.
  • Surveillance de la conformité: Comparer les documents de politique pour assurer la conformité réglementaire
  • Examen des documents du clientSuivre les modifications apportées aux documents juridiques destinés aux clients

Obtenez de l'aide​

Get Your API KeyAPI SamplesGetting Started