Dividi documento - Divisione del documento API
PDF4me Dividi il documento consente di dividere i documenti Word in più documenti più piccoli con opzioni di suddivisione flessibili e un controllo completo della configurazione. API Il servizio elabora i file Word e li suddivide per pagine, sezioni, intestazioni o intervalli di pagine personalizzati con il pieno controllo sui criteri di suddivisione, la denominazione dei documenti e l'organizzazione dell'output. API riceve il contenuto del documento Word tramite REST API chiamate, utilizzando Base64 Codifica per una trasmissione sicura. Grazie al supporto per la suddivisione in pagine, sezioni, intestazioni e intervalli di pagine personalizzati, questa soluzione è ideale per la gestione dei documenti, la distribuzione dei contenuti e l'automazione dei flussi di lavoro.
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
- Diversi tipi di splitSuddivisione per pagine, sezioni, intestazioni o intervalli personalizzati
- Supporto per intervalli di pagineSuddivisione in base a numeri di pagina o intervalli specifici
- Suddivisione in sezioni: Dividi il documento dopo ogni sezione di Word
- Divisione basata sulla voce: Dividi il documento dopo ogni intestazione dello stile specificato (ad esempio, Intestazione 1, Intestazione 2)
- Configurazione flessibile: Criteri di suddivisione personalizzati con parametro splitConfig
- Nomi univoci dei documentiOgni documento suddiviso riceve un nome file GUID univoco
- Conservazione del formatoMantiene la formattazione e la struttura originali del documento.
- Supporto culturaleElaborazione dei documenti specifici per la località
REST API Punto finale
IL PDF4me REST API utilizza standard HTTP Metodi per interagire con le risorse. Tutte le operazioni di suddivisione dei documenti vengono eseguite tramite un unico endpoint:
- Metodo: POST
- Punto finale:
office/ApiV2Word/SplitDocument
REST API Parametri
Elenco completo dei parametri per la divisione del documento REST APII parametri sono organizzati per categoria per una migliore comprensione e implementazione.
Importante: I parametri contrassegnati da un asterisco (*) sono obbligatori.
splitConfigil parametro è richiesto quandosplitTypeè "array", "numberofpages" o "headings".
Parametri richiesti
| Parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| documento* | Object | Riferimento al documento. Deve contenere Nome string): Nome del file Word con estensione .docx. Utilizzato per riferimento ed elaborazione | { "Name": "document.docx" } |
| docContent* | Base64 | Il contenuto del documento Word codificato in Base64Il documento viene suddiviso in base a criteri specifici. Deve essere un documento Word valido (formati .docx, .doc). | base64EncodedDocumentContent |
Parametri opzionali
| Parametro | Tipo | Descrizione | Esempio |
|---|---|---|---|
| splitType | String | Tipo di suddivisione del documento. Opzioni: allpages - Dividi in singole pagine (impostazione predefinita), array - Suddivisione in base a intervalli di pagine espliciti (ad esempio "1-3,4,5-7"), numberofpages - Dividi dopo ogni N pagine (configurazione: numero intero positivo come "3" o "5"), section - Dividi il documento dopo ogni sezione, headings - Dividi il documento dopo ogni intestazione dello stile specificato (ad esempio "Intestazione 1"). Ogni documento diviso ottiene un identificativo univoco GUID nomefile | "allpages" |
| splitConfig | String | Configurazione per la suddivisione. Per array: Intervalli di pagine come "1-3,4,5-7" (pagine 1-3, pagina 4, pagine 5-7) o singole pagine "1,3,5". Per numero di pagine: Un numero intero positivo come "3" o "5" : divide dopo ogni N pagine. Per le intestazioniNome dello stile di intestazione, ad esempio "Intestazione 1" o "Intestazione 2". Obbligatorio quando splitType è "array", "numberofpages" o "headings". La numerazione delle pagine è basata su 1. La corrispondenza delle intestazioni non fa distinzione tra maiuscole e minuscole. | "1-3,4,5-7" O "3" O "Heading 1" |
| Nome della cultura | String | Codice cultura per l'elaborazione dei documenti (ad es. "en-US", "de-DE", "fr-FR"). Predefinito: "en-US". Influisce sulla lingua e sulla formattazione del documento. Utilizzato per la gestione dei metadati e della localizzazione. | en-US |
Opzioni di tipo split
IL API offre diversi tipi di suddivisione per la divisione del documento:
| Tipo diviso | Descrizione | Richiede splitConfig | Caso d'uso |
|---|---|---|---|
| allpages | Dividi in pagine individuali (impostazione predefinita) | NO | Estrai ogni pagina come documento separato |
| array | Suddivisione in base a intervalli di pagine espliciti. Ogni intervallo separato da virgole diventa un documento (ad esempio, "1-3,4,5-7" → 3 documenti). | SÌ | Crea documenti a partire da intervalli di pagine specifici o da singole pagine. |
| numberofpages | Suddivisione dopo ogni N pagine. Suddivisione sequenziale: ogni N pagine formano un documento; la parte rimanente è l'ultimo documento. | SÌ | Suddividere in sezioni di uguale lunghezza (ad esempio, ogni 3 o 5 pagine) |
| section | Dividi il documento dopo ogni sezione di Word | NO | Un documento per sezione |
| headings | Dividi il documento dopo ogni intestazione dello stile specificato (ad esempio, "Intestazione 1"). | SÌ | Estrarre capitoli o parti per livello di intestazione |
Esempi di configurazione divisa
Comprendere la configurazione della divisione dei documenti aiuta a ottimizzare i flussi di lavoro relativi a questa operazione:
array: intervalli di pagine espliciti
"1-3,4,5-7"→ 3 documenti: pagine 1-3, pagina 4, pagine 5-7"1,3,5"→ 3 documenti: pagina 1, pagina 3, pagina 5"1-5,6-10"→ 2 documenti: pagine 1-5, pagine 6-10
numberofpages: suddivisione dopo ogni N pagine
Comportamento: Suddivide sequenzialmente dopo ogni N pagine.
Configurazione: Obbligatorio, il formato è un singolo numero intero positivo (ad esempio "3", "5").
Esempi:
- Configurazione
"3"Su un documento di 10 pagine → 4 documenti: Documento 1: pagine 1-3, Documento 2: pagine 4-6, Documento 3: pagine 7-9, Documento 4: pagina 10 - Configurazione
"5"Su un documento di 12 pagine → 3 documenti: Documento 1: pagine 1-5, Documento 2: pagine 6-10, Documento 3: pagine 11-12
headings: dividere dopo ogni intestazione
"Heading 1", un documento per blocco che termina con il successivo Titolo 1 (o fine documento)"Heading 2", un documento per blocco che termina con il successivo Titolo 2 (o fine del documento)- corrispondenza senza distinzione tra maiuscole e minuscole
section
Non è necessaria alcuna configurazione. Il documento viene suddiviso dopo ogni interruzione di sezione di Word; ogni sezione diventa un documento a sé stante.
Produzione
IL PDF4me Dividi il documento REST API restituisce il risultato della divisione come JSON. IL API restituisce un singolo documento nella risposta (il primo documento suddiviso), con i campi di risposta standard.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Elaborazione sincrona (impostazione predefinita)
IL API elabora la richiesta e restituisce il primo documento suddiviso:
Codice di stato: 200 OK
Tipo di contenuto: application/json
Corpo della risposta:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "a1b2c3d4-e5f6-7890-abcd-ef1234567890.docx",
"success": true,
"errorMessage": null
}
Campi di risposta:
- documento string): Il primo contenuto del documento diviso, codificato come Base64 corda
- Nome file string): Nome file generato per il documento diviso (GUID-basato)
- successo boolean): Indica se la richiesta è andata a buon fine
- messaggio di errore string 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
- Utilizzare il
fileNameper salvare il documento diviso
Esempio (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save with data.fileName or custom name
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 (
documentoconNome,docContent) - Configurazione di suddivisione non valida fornita
splitConfigè richiesto quandosplitTypeè "array", "numberofpages" o "headings"- Non valido Base64 codifica in
docContent - Documento Word non valido o danneggiato
- Nessuna intestazione trovata nel documento (per la suddivisione in base alle intestazioni)
- Intervallo di pagine specificato non valido (il numero di pagine supera il numero totale di pagine del documento).
- Tipo di suddivisione non valido
- 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 la suddivisione del documento
- Errore durante il caricamento del documento dai byte
- Errore durante la conversione del documento in byte
Formato della risposta di errore:
{
"error": "Error message describing what went wrong"
}
Dettagli sul formato di risposta
Importante: IL API ritorna sempre JSON con una serie di documenti, mai dati Word binari direttamente.
Struttura della risposta:
{
"document": "string", // Base64-encoded Word document content (first split)
"fileName": "string", // GUID-based filename (e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890.docx")
"success": true,
"errorMessage": "string or null"
}
Intestazione Content-Type:
- Successo:
application/json - Il documento diviso è incorporato come un 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
// Save with response.fileName or custom name
Python:
import base64
response_data = response.json()
word_bytes = base64.b64decode(response_data['document'])
filename = response_data['fileName']
with open(filename, 'wb') as f:
f.write(word_bytes)
C#:
byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes(response.fileName, 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 base (Dividi tutte le pagine - Impostazione predefinita):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "allpages"
}
Esempio di intervallo di pagine (array):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "array",
"splitConfig": "1-3,4,5-7"
}
Dividi dopo ogni N pagine Esempio (numero di pagine):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "numberofpages",
"splitConfig": "3"
}
Esempio basato su intestazioni (separare dopo ogni intestazione):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "headings",
"splitConfig": "Heading 1",
"cultureName": "en-US"
}
Esempio basato su sezioni (suddivisione dopo ogni sezione):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "section",
"cultureName": "en-US"
}
Esempi di codice
IL PDF4me Dividi il documento 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
- Gestione dei contrattiSuddividere i contratti multipartitici in sezioni individuali
- Documentazione del caso: Estrarre pagine specifiche dai fascicoli del caso
- Rapporti di conformitàDistribuire le sezioni pertinenti ai diversi dipartimenti
- Ricerca giuridicaSuddividere documenti legali di grandi dimensioni per argomento o sezione
Casi d'uso aziendali e per le imprese
- Distribuzione dei report: Suddividere i report per sezione in base alle diverse parti interessate
- Gestione delle proposteEstrarre le sezioni relative ai documenti specifici per il cliente
- Documentazione interna: Dividere i manuali per argomento o reparto
- Organizzazione dell'archivio: Creare blocchi logici di documenti per l'archiviazione e il recupero
Casi d'uso in ambito educativo e di ricerca.
- Materiali didattici: Dividere i libri di testo in singoli capitoli
- Documenti degli studentiEstrarre pagine specifiche per diversi dipartimenti accademici
- Articoli di ricercaSuddividere i documenti di grandi dimensioni in sezioni per la revisione paritaria.
- Documentazione medica e di ricerca: Suddividere i documenti di ricerca o clinici per metodologia o sezione
Casi d'uso in ambito finanziario e bancario
- Rapporti finanziariDistribuire sezioni specifiche ai diversi soggetti interessati
- Documentazione di audit: Estrarre le pagine pertinenti per le diverse aree di audit
- Conformità normativa: Suddividere i documenti di conformità per tipologia di regolamento
- Valutazione del rischioDistribuire le sezioni relative ai rischi ai team appropriati.