Unione documenti - Assemblaggio documenti API
PDF4me Unisci documenti consente di combinare più documenti Word in un unico documento con opzioni di formattazione e conformità avanzate. Questo API Il servizio elabora più file Word e li unisce con un ordinamento flessibile dei documenti, modalità di formattazione personalizzabili, impostazioni del livello di conformità, metadati del fuso orario e gestione intelligente dello stile. API riceve il contenuto del documento tramite REST API chiamate, utilizzando Base64 Codifica per una trasmissione sicura. Grazie al supporto per l'unione illimitata di documenti e al controllo completo sul comportamento di unione, questa soluzione è ideale per l'assemblaggio di documenti, il consolidamento di report e i flussi di lavoro di gestione dei contenuti.
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
- Supporto per più documenti: Unisci un numero illimitato di documenti in uno solo
- Struttura semplice dell'array: Serie di facile utilizzo Base64-contenuto del documento codificato
- Unione ordinata: I documenti sono uniti nell'ordine in cui appaiono nell'array
- Concetto di documento di base: Il primo documento diventa la base per la fusione
- Supporto per più formati: Unisci documenti Word, PDF e altri formati supportati
REST API Punto finale
IL PDF4me REST API utilizza standard HTTP Metodi per interagire con le risorse. Tutte le operazioni di unione dei documenti vengono eseguite tramite un unico endpoint:
- Metodo: POST
- Punto finale:
office/ApiV2Word/MergeDocuments
REST API Parametri
Elenco completo dei parametri per l'unione dei documenti REST APII parametri sono organizzati per categoria per una migliore comprensione e implementazione.
Importante: I parametri contrassegnati da un asterisco (*) sono obbligatori. Documenti L'array deve contenere almeno un documento.
Parametri richiesti
| Parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| Documenti* | Array | Array di oggetti documento da unire. Deve contenere almeno un documento. Ogni oggetto deve avere nome file (stringa) e docContent Base64 stringa). I documenti vengono uniti nell'ordine in cui appaiono nell'array. Campi opzionali per documento: posizione di ordinamento (intero), modalità formato (corda) | [{ "filename": "doc1.docx", "docContent": "base64..." }, { "filename": "doc2.docx", "docContent": "base64..." }] |
Parametri opzionali
| Parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| opzioni di unione | Object | Opzioni di unione (formattazione, conformità, ecc.). Consultare il modello del plugin per le proprietà disponibili. | {} |
Ordine di unione dei documenti
I documenti vengono uniti nell'ordine in cui appaiono nel Documenti vettore:
- Il primo documento nell'array diventa il documento base
- Tutti i documenti successivi sono allegato al documento base in ordine di array
Produzione
IL PDF4me Unisci 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": "merged-document.docx",
"success": true,
"errorMessage": null
}
Campi di risposta:
- documento (stringa): Il documento Word unito contenente tutti i documenti di input, codificato come Base64 corda
- Nome file (stringa): Il nome del file Word di output
- 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
- Salva o elabora il file Word 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
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 (
Documentivettore) - Nessun documento da unire (array di documenti vuoto)
- Non valido Base64 codifica nel contenuto del documento
- Documenti non validi o corrotti
- 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 durante l'unione 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 content
"fileName": "string", // Output Word filename
"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('output.docx', 'wb') as f:
f.write(word_bytes)
C#:
byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes("output.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 (due documenti):
{
"documents": [
{ "filename": "doc1.docx", "docContent": "base64EncodedDocument1" },
{ "filename": "doc2.docx", "docContent": "base64EncodedDocument2" }
]
}
Esempio avanzato (più documenti con opzioni di unione):
{
"documents": [
{ "filename": "doc1.docx", "docContent": "base64EncodedDocument1" },
{ "filename": "doc2.docx", "docContent": "base64EncodedDocument2" },
{ "filename": "doc3.docx", "docContent": "base64EncodedDocument3" }
],
"mergeOptions": {}
}
Esempi di codice
IL PDF4me Unisci 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
- Assemblaggio a contratto: Unire le sezioni del contratto in documenti legali completi
- Consolidamento di memorie legali: Unire più sezioni di brevi documenti in memorie legali complete
- Documentazione di conformità: Consolidare i documenti di conformità per le presentazioni normative
- Assemblaggio della documentazione del cliente: Unire i documenti specifici del cliente in pacchetti completi
Casi d'uso aziendali e per le imprese
- Proposta di Assemblea: Unire le sezioni della proposta in proposte complete per il cliente
- Consolidamento del materiale di marketing: Unire i documenti di marketing per le campagne
- Assemblaggio per la presentazione di vendita: Unire le sezioni della presentazione in presentazioni complete
- Assemblaggio del prodotto da consegnare al cliente: Consolidare i materiali specifici del cliente
Casi d'uso in ambito educativo e di ricerca.
- Assemblaggio del referto medico: Unire le sezioni del referto medico in referti completi per paziente
- Documentazione del protocollo: Unire le sezioni del protocollo in protocolli medici completi
- Documentazione di ricerca: Raccogliere i documenti di ricerca per la redazione dei rapporti di studio
- Assemblaggio del manuale di conformità: Unire i documenti di conformità sanitaria
Casi d'uso in ambito finanziario e bancario
- Assemblaggio del bilancio: Unire le sezioni del rendiconto finanziario in rendiconti completi
- Documentazione di auditConsolidare i documenti di revisione per redigere relazioni di revisione complete.
- Consolidamento del bilancioUnire le sezioni di bilancio di diversi dipartimenti
- Assemblaggio per la presentazione regolamentare: Unire i documenti normativi per l'invio