Confronta documenti - Confronto documenti API
PDF4me Confronta documenti consente di confrontare due documenti Word e tenere traccia delle modifiche con opzioni di confronto complete. Questo API Il servizio elabora due file Word e genera un documento di confronto con tracciamento dettagliato delle modifiche, impostazioni di confronto personalizzabili, gestione delle revisioni e report di confronto professionali. API riceve entrambi i contenuti del documento tramite REST API chiamate, utilizzando Base64 Codifica per una trasmissione sicura. Con il pieno controllo su formattazione, distinzione tra maiuscole e minuscole, commenti, tabelle, campi, note a piè di pagina, caselle di testo e intestazioni/piè di pagina, questa soluzione è ideale per la revisione dei documenti, il controllo delle versioni e i flussi di lavoro di modifica collaborativa.
Autenticazione del tuo API Richiesta
Per accedere al PDF4me REST API, ogni richiesta deve includere credenziali di autenticazione adeguate. L'autenticazione garantisce una comunicazione sicura e convalida la tua identità come utente autorizzato del REST API.
Caratteristiche principali
- Confronto dei documentiConfronta due documenti Word e individua tutte le differenze.
- Modifiche alla traccia: Genera documenti con modifiche tracciate che mostrano le modifiche
- Opzioni personalizzabili: Controlla quali tipi di modifiche monitorare o ignorare
- Gestione delle revisioni: Pulire le revisioni esistenti prima del confronto
- Attribuzione dell'autoreAssegnare le modifiche ad autori specifici per garantirne la responsabilità.
- Produzione professionaleGenera documenti di confronto chiari con tracciamento delle revisioni
- Supporto per più formati: Confronta i file .docx e .doc
- Filtro avanzato: Ignora formattazione, maiuscole/minuscole, commenti, tabelle e altro
REST API Punto finale
IL PDF4me REST API utilizza standard HTTP Metodi per interagire con le risorse. Tutte le operazioni di confronto dei documenti vengono eseguite tramite un unico endpoint:
- Metodo: POST
- Punto finale:
office/ApiV2Word/CompareDocuments
REST API Parametri
Elenco completo dei parametri per il confronto dei documenti REST APII parametri sono organizzati per categoria per una migliore comprensione e implementazione.
Importante: I parametri contrassegnati da un asterisco (*) sono obbligatori e devono essere forniti per il API per funzionare correttamente.
Parametri richiesti
| Parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| primoDocumento* | Object | Primo riferimento al documento (base). Deve contenere Nome (stringa): nome del documento con estensione (.docx, .doc). Questo documento funge da base per il confronto. | { "Name": "original.docx" } |
| firstDocContent* | Base64 | Base64- Contenuto codificato del primo documento. Deve essere un documento Word valido (formati .docx, .doc). | UEsDBBQABgAIAAAA... |
| secondoDocumento* | Object | Secondo riferimento al documento (di confronto). Deve contenere Nome (stringa): nome del documento con estensione (.docx, .doc). Questo documento viene confrontato con il primo | { "Name": "modified.docx" } |
| secondoContenutoDocumento* | Base64 | Base64- Contenuto codificato del secondo documento. Deve essere un documento Word valido (formati .docx, .doc). | UEsDBBQABgAIAAAA... |
Parametri opzionali (Opzioni di confronto)
| Parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| opzioni di confronto | Object | Impostazioni di confronto. Proprietà: ignora la formattazione (booleano), ignora le modifiche al maiuscolo/minuscolo (booleano), ignora i commenti (booleano), ignoraTabelle (booleano), ignoreFields (booleano), ignora le note a piè di pagina (booleano), ignora le caselle di testo (booleano), ignoraIntestazioniEPiocchi (booleano), autore (stringa). Vedi le opzioni di confronto qui sotto | { "ignoreFormatting": false, "author": "John Doe" } |
Opzioni di confronto
IL API offre un controllo preciso sulle modifiche da monitorare:
Opzioni di contenuto:
- ignora la formattazioneConcentrati sul contenuto testuale, ignora le modifiche di stile.
- ignora le modifiche al maiuscolo/minuscolo: Confronto senza distinzione tra maiuscole e minuscole
- ignora i commenti: Escludi le modifiche ai commenti dal confronto
- ignoraTabelle: Escludi modifiche alla struttura e al contenuto della tabella
- ignoreFields: Escludi gli aggiornamenti dei campi (contenuto ad aggiornamento automatico)
Opzioni degli elementi del documento:
- ignora le note a piè di pagina: Escludi le modifiche alle note a piè di pagina
- ignora le caselle di testo: Escludi le modifiche alla casella di testo
- ignoraIntestazioniEPiocchi: Escludi le modifiche all'intestazione/piè di pagina
Attribuzione:
- autoreImposta il nome dell'autore per le modifiche rilevate nel documento di confronto.
Produzione
IL PDF4me Confronta documenti REST API restituisce risposte diverse a seconda della modalità di elaborazione. API restituisce il documento Word come un Base64-stringa codificata in JSON formato, non come dati binari.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Elaborazione sincrona (impostazione predefinita)
IL API elabora la richiesta e restituisce:
Codice di stato: 200 OK
Tipo di contenuto: application/json
Corpo della risposta:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "comparison-result.docx",
"success": true,
"errorMessage": null
}
Campi di risposta:
- documento (stringa): Il documento Word con le modifiche tracciate che mostrano tutte le differenze, codificato come Base64 corda
- Nome file (stringa): Nome del file Word di output con i risultati del confronto
- successo (booleano): Indica se la richiesta è andata a buon fine
- messaggio di errore (stringa o null): Dettagli dell'errore quando il successo è falso
Come si usa:
- Estrarre il
documentcampo dal JSON risposta (Base64) - decodificare il Base64 stringa per ottenere i dati binari del documento Word
- Apri il documento in Word per visualizzare le modifiche rilevate.
- Accettare o rifiutare le modifiche secondo necessità
Esempio (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
Elaborazione asincrona
Comportamento asincrono (202 Accepted con polling) è controllato dalla configurazione del server, non da un parametro del corpo della richiesta. Quando abilitato, il API potrebbe restituire uno stato 202 con un polling URL nel Location intestazione. Interroga l' URL con GET richieste fino a quando non ne ricevi 200 OK con la stessa struttura di risposta (documento, nomefile, successo, messaggiodierrore).
Risposte di errore
IL API resi standard HTTP Codici di errore con dettagli dell'errore:
- Parametri di richiesta non validi
- Campi obbligatori mancanti (
primoDocumentoconNome,firstDocContent,secondoDocumentoconNome,secondoContenutoDocumento) - Il primo documento è vuoto o nullo
- Il secondo documento è vuoto o nullo
- Non valido Base64 codifica nel contenuto del documento
- Documenti Word non validi o danneggiati
- Non valido o mancante API chiave
- API chiave non corretta Base64 codificato in Authorization intestazione
- Mancante
Autorizzazione: Baseintestazione
- Errore di elaborazione lato server
- Errore nell'elaborazione del documento Word
- Errore di confronto dei documenti
Formato della risposta di errore:
{
"error": "Error message describing what went wrong"
}
Dettagli sul formato di risposta
Importante: IL API ritorna sempre JSON, mai dati Word binari direttamente.
Struttura della risposta:
{
"document": "string", // Base64-encoded Word document with tracked changes
"fileName": "string", // Output Word filename with comparison results
"success": true,
"errorMessage": "string or null"
}
Intestazione Content-Type:
- Successo:
application/json - Il documento Word è incorporato come Base64 stringa all'interno della JSON risposta
Perché Base64?
- JSON- codifica sicura per dati binari
- Facile da trasmettere HTTP
- Compatibile con tutti i linguaggi di programmazione
- Può essere incorporato direttamente in JSON senza sfuggire ai problemi
Codifica Base64 al documento 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('comparison.docx', 'wb') as f:
f.write(word_bytes)
C#:
byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes("comparison.docx", wordBytes);
Esempio di richiesta
Intestazione
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Nota:
- Ottieni il tuo API chiave dalla PDF4me Pannello di controllo
- IL API la chiave deve essere Base64 codificato e prefissato con "Basic" nel Authorization intestazione
- Esempio: se il tuo API la chiave è
abc123, codificalo in Base64 e utilizzareAuthorization: Basic YWJjMTIz
Carico utile
Esempio di base (solo campi obbligatori):
{
"firstDocument": { "Name": "original.docx" },
"firstDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"secondDocument": { "Name": "modified.docx" },
"secondDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC..."
}
Esempio avanzato (con opzioni di confronto):
{
"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"
}
}
Esempio di confronto basato esclusivamente sul contenuto:
{
"firstDocument": { "Name": "original.docx" },
"firstDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"secondDocument": { "Name": "modified.docx" },
"secondDocContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"comparisonOptions": {
"ignoreFormatting": true,
"ignoreCaseChanges": true,
"ignoreComments": true,
"ignoreFields": true,
"author": "Content Review"
}
}
Esempi di codice
IL PDF4me Confronta documenti REST API Fornisce esempi di codice in diversi linguaggi di programmazione. Scegli il linguaggio più adatto al tuo ambiente di sviluppo:
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
Java Campione
Java implementazione con gestione completa degli errori ed elaborazione delle risposte:
JavaScript Campione
Node.js e compatibile con i browser JavaScript implementazione:
Google Script Campione
Google Apps Script implementazione per Google Workspace integrazione:
Casi d'uso e applicazioni industriali
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
Casi d'uso per servizi legali e professionali
- Revisione del contrattoConfrontare le versioni del contratto per identificare modifiche e variazioni.
- Aggiornamenti dei documenti legaliMonitora le modifiche apportate a memorie legali, accordi e documenti giudiziari.
- Monitoraggio della conformità: Confrontare i documenti relativi alle politiche per garantire la conformità normativa
- Revisione della documentazione del cliente: Monitorare le modifiche apportate ai documenti legali destinati ai clienti
Casi d'uso aziendali e per le imprese
- Gestione delle proposteConfronta le diverse versioni della proposta per monitorare i requisiti del cliente.
- Aggiornamenti del materiale di marketing: Monitorare le modifiche apportate al materiale di marketing e alle campagne
- Modifiche al documento dei prezziConfronta i listini prezzi e le tariffe
- Aggiornamenti sulla presentazione al cliente: Monitorare le modifiche apportate ai materiali di presentazione al cliente
Casi d'uso in ambito educativo e di ricerca.
- Aggiornamenti del protocollo medico: Confrontare i documenti relativi a procedure e protocolli medici
- Linee guida per l'assistenza al paziente: Monitorare le modifiche nella documentazione relativa all'assistenza al paziente
- Documentazione di ricerca: Confrontare i protocolli di ricerca e i documenti di studio
- Documentazione di conformità: Monitorare le modifiche ai materiali relativi alla conformità in ambito sanitario
Casi d'uso in ambito finanziario e bancario
- Aggiornamenti del bilancio: Confronta i rendiconti finanziari trimestrali e annuali
- Modifiche al documento di bilancio: Monitorare le modifiche alle proposte e ai rapporti di bilancio
- Documentazione di audit: Confrontare i report di audit relativi a periodi diversi
- Documenti normativi: Monitorare le modifiche nei documenti presentati alle autorità di regolamentazione