Division du document - Division du document API
PDF4me Document fractionné permet de diviser les documents Word en plusieurs documents plus petits grâce à des options de fractionnement flexibles et à un contrôle de configuration complet. API Ce service traite les fichiers Word et les divise par pages, sections, titres ou plages de pages personnalisées, avec un contrôle total sur les critères de division, le nommage des documents et l'organisation de la sortie. API reçoit le contenu des documents Word via REST API appels, utilisant Base64 Encodage pour une transmission sécurisée. Grâce à la prise en charge du fractionnement par page, de la division par section, de la séparation par titre et des plages de pages personnalisées, cette solution est idéale pour la gestion documentaire, la distribution de contenu et l'automatisation des flux de travail.
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.
Caractéristiques principales
- Types de division multiples: Diviser par pages, sections, titres ou plages personnalisées
- Prise en charge des plages de pages: Fractionner en fonction de numéros de page ou de plages spécifiques
- Division par sectionsDivisez le document après chaque section Word.
- Division basée sur les titres: Diviser le document après chaque titre du style spécifié (par exemple, Titre 1, Titre 2)
- Configuration flexible: Critères de fractionnement personnalisés avec le paramètre splitConfig
- Noms uniques de documentsChaque document divisé reçoit un nom de fichier GUID unique.
- Préservation du format: Conserve la mise en forme et la structure originales du document
- Soutien culturelTraitement de documents spécifique à la langue
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 fractionnement de documents sont effectuées via un point de terminaison unique :
- Méthode: POST
- Point final :
office/ApiV2Word/SplitDocument
REST API Paramètres
Liste complète des paramètres pour le document fractionné 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.
splitConfigle paramètre est requis lorsquesplitTypeest « tableau », « nombre de pages » ou « titres ».
Paramètres requis
| Paramètre | Taper | Description | Exemple |
|---|---|---|---|
| document* | Object | Référence du document. Doit contenir Nom (stringNom de fichier Word avec l'extension .docx. Utilisé pour la référence et le traitement. | { "Name": "document.docx" } |
| docContent* | Base64 | Contenu du document Word encodé en Base64Le document est divisé selon des critères spécifiés. Il doit s'agir d'un document Word valide (formats .docx ou .doc). | base64EncodedDocumentContent |
Paramètres optionnels
| Paramètre | Taper | Description | Exemple |
|---|---|---|---|
| splitType | String | Type de fractionnement de document. Options : allpages - Diviser en pages individuelles (par défaut), array - Séparer par plages de pages explicites (par exemple « 1-3,4,5-7 »), numberofpages - Division après chaque N pages (configuration : entier positif comme « 3 » ou « 5 »), section - Divisez le document après chaque section, headings - Divisez le document après chaque titre du style spécifié (par exemple, « Titre 1 »). Chaque document divisé reçoit un identifiant unique. GUID nom de fichier | "allpages" |
| splitConfig | String | Configuration pour le fractionnement. Pour le tableau: Plages de pages comme « 1-3,4,5-7 » (pages 1-3, page 4, pages 5-7) ou pages individuelles « 1,3,5 ». Pour le nombre de pages: Un entier positif comme « 3 » ou « 5 » : divisions après chaque N pages. Pour les titresNom du style de titre, par exemple « Titre 1 » ou « Titre 2 ». Obligatoire lorsque splitType est « array », « numberofpages » ou « headings ». La numérotation des pages commence à 1. La correspondance des titres ne tient pas compte de la casse. | "1-3,4,5-7" ou "3" ou "Heading 1" |
| nom de la culture | String | Code de culture pour le traitement des documents (par exemple, « en-US », « de-DE », « fr-FR »). Par défaut : « en-US ». Affecte la langue et la mise en forme du document. Utilisé pour la gestion des métadonnées et de la localisation. | en-US |
Options de type split
Le API propose différents types de division pour les documents :
| Type divisé | Description | Nécessite splitConfig | Cas d'utilisation |
|---|---|---|---|
| allpages | Diviser en pages individuelles (par défaut) | Non | Extraire chaque page comme un document séparé |
| array | Séparation par plages de pages explicites. Chaque plage séparée par des virgules devient un document (par exemple, « 1-3,4,5-7 » → 3 documents). | Oui | Créez des documents à partir de plages de pages spécifiques ou de pages individuelles |
| numberofpages | Division séquentielle : chaque groupe de N pages forme un document ; le reste constitue le dernier document. | Oui | Divisez en morceaux de taille égale (par exemple toutes les 3 ou 5 pages). |
| section | Divisez le document après chaque section Word | Non | Un document par section |
| headings | Divisez le document après chaque titre du style spécifié (par exemple « Titre 1 »). | Oui | Extraire les chapitres ou les parties par niveau de titre |
Exemples de configuration fractionnée
Comprendre la configuration de fractionnement permet d'optimiser vos flux de travail de fractionnement de documents :
array: plages de pages explicites
"1-3,4,5-7"→ 3 documents : pages 1 à 3, page 4, pages 5 à 7"1,3,5"→ 3 documents : page 1, page 3, page 5"1-5,6-10"→ 2 documents : pages 1-5, pages 6-10
numberofpages: division après chaque N pages
Comportement: Division séquentielle après chaque N pages.
Configuration : Obligatoire, le format est un seul entier positif (par exemple, "3", "5").
Exemples :
-
Configuration
"3"Sur un document de 10 pages → 4 documents :Document 1 : pages 1 à 3, Document 2 : pages 4 à 6, Document 3 : pages 7 à 9, Document 4 : page 10
-
Configuration
"5"Sur un document de 12 pages → 3 documents :Document 1 : pages 1 à 5, Document 2 : pages 6 à 10, Document 3 : pages 11 et 12
headings: séparation après chaque titre
"Heading 1", un document par bloc qui se termine au prochain titre de niveau 1 (ou à la fin du document)"Heading 2", un document par bloc qui se termine au prochain titre de niveau 2 (ou à la fin du document)- Appariement insensible à la casse
section
Aucune configuration requise. Le document est divisé après chaque saut de section Word ; chaque section devient un document distinct.
Sortir
Le PDF4me Document fractionné REST API renvoie le résultat de la division sous forme de JSON. Le API renvoie un seul document dans la réponse (le premier document divisé), avec des champs de réponse standard.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Traitement synchrone (par défaut)
Le API traite la requête et renvoie le premier document fractionné :
Code d'état : 200 OK
Type de contenu : application/json
Corps de la réponse :
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "a1b2c3d4-e5f6-7890-abcd-ef1234567890.docx",
"success": true,
"errorMessage": null
}
Champs de réponse :
- document (string): Le contenu du premier document divisé, encodé comme Base64 chaîne
- nom de fichier (string): Nom de fichier généré pour le document divisé (GUID-basé)
- succès (boolean): Indique si la requête a abouti
- message d'erreur (string ou null) : Détails de l’erreur en cas de succès faux
Mode d'emploi :
- Extraire le
documentchamp du JSON réponse (Base64) - Décodez le Base64 chaîne permettant d'obtenir les données binaires d'un document Word
- Utilisez le
fileNamepour enregistrer le document divisé
Exemple (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
Traitement asynchrone
Comportement asynchrone (202) Accepted (avec interrogation) est contrôlé par la configuration du serveur, et non par un paramètre du corps de la requête. Lorsqu'il est activé, le API peut renvoyer un statut 202 avec un sondage URL dans le Location En-tête. Interroger l'en-tête. URL avec GET demandes jusqu'à ce que vous en receviez 200 OK avec la même forme de réponse (document, nom_de_fichier, succès, message_d'erreur).
Réponses d'erreur
Le API retours standard HTTP codes d'erreur avec détails de l'erreur :
- Paramètres de requête invalides
- Champs obligatoires manquants (
documentavecNom,docContent) - Configuration de fractionnement invalide fournie
splitConfigest requis lorsquesplitTypeest « tableau », « nombre de pages » ou « titres »- Invalide Base64 encodage dans
docContent - Document Word invalide ou corrompu
- Aucun titre trouvé dans le document (pour le fractionnement par titre)
- Plage de pages non valide (le nombre de pages dépasse le nombre de pages du document)
- Type de fractionnement invalide
- Invalide ou manquant API clé
- API clé non correctement Base64 encodé dans Authorization en-tête
- Manquant
Autorisation : de baseen-tête
- Erreur de traitement côté serveur
- Échec du traitement du document Word
- Erreur lors de la division du document
- Erreur lors du chargement du document à partir de bytes
- Erreur lors de la conversion du document en octets
Format de réponse en cas d'erreur :
{
"error": "Error message describing what went wrong"
}
Détails du format de réponse
Important: Le API toujours retourne JSON avec un ensemble de documents, jamais directement de données binaires Word.
Structure de la réponse :
{
"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"
}
En-tête Content-Type :
- Succès:
application/json - Le document divisé est intégré en tant que Base64 chaîne à l'intérieur de la JSON réponse
Pourquoi Base64?
- JSON-codage sûr pour les données binaires
- Facile à transmettre sur HTTP
- Compatible avec tous les langages de programmation
- Peut être directement intégré dans JSON sans échapper aux problèmes
Décodage Base64 vers un document 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);
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 utiliserAuthorization: Basic YWJjMTIz
Charge utile
Exemple de base (Fractionner toutes les pages - Par défaut) :
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "allpages"
}
Exemple de plage de pages (tableau) :
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "array",
"splitConfig": "1-3,4,5-7"
}
Exemple de fractionnement après chaque N pages (nombre de pages) :
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "numberofpages",
"splitConfig": "3"
}
Exemple basé sur les titres (séparation après chaque titre) :
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "headings",
"splitConfig": "Heading 1",
"cultureName": "en-US"
}
Exemple structuré par sections (séparation après chaque section) :
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "section",
"cultureName": "en-US"
}
Exemples de code
Le PDF4me Document fractionné 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#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
C# (CSharp) Échantillon
Complet C# implémentation pour la division des documents Word :
Java Échantillon
Java implémentation avec gestion complète des erreurs et traitement des réponses :
JavaScript Échantillon
Node.js et compatible avec les navigateurs JavaScript mise en œuvre:
Python Échantillon
Python implémentation avec la bibliothèque requests et JSON manutention:
Google Script Échantillon
Google Apps Script mise en œuvre pour Google Workspace intégration :
Cas d'utilisation et applications industrielles
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
Cas d'utilisation des services juridiques et professionnels
- Gestion des contratsDiviser les contrats multipartites en sections individuelles
- Documentation du dossierExtraire des pages spécifiques des dossiers judiciaires
- Rapports de conformitéRépartir les sections pertinentes entre les différents départements
- Recherche juridiqueDivisez les documents juridiques volumineux par sujet ou section.
Cas d'utilisation en entreprise
- Distribution des rapportsRépartir les rapports par section pour les différentes parties prenantes
- Gestion des propositionsExtraire les sections pour les livrables spécifiques au client
- Documentation interne: Divisez les manuels par sujet ou par département
- Organisation des archivesCréer des blocs de documents logiques pour le stockage et la récupération
Cas d'utilisation dans le domaine de l'éducation et de la recherche
- Matériel pédagogiqueDiviser les manuels scolaires en chapitres individuels
- Dossiers des élèvesExtraire des pages spécifiques pour différents départements universitaires
- Articles de rechercheDiviser les articles volumineux en sections pour l'évaluation par les pairs
- Documentation médicale et de recherche: Séparer les documents de recherche ou cliniques par méthodologie ou section
Cas d'utilisation dans le secteur financier et bancaire
- Rapports financiersRépartir des sections spécifiques entre les différentes parties prenantes
- Documentation d'auditExtraire les pages pertinentes pour les différents domaines d'audit.
- Conformité réglementaire: Répartir les documents de conformité par type de réglementation
- L'évaluation des risquesRépartir les sections relatives aux risques entre les équipes concernées