Fusion de documents - Assemblage de documents API
PDF4me Fusionner les documents vous permet de combiner plusieurs documents Word en un seul document avec des options avancées de mise en forme et de conformité. API Ce service traite plusieurs fichiers Word et les fusionne avec un ordre de documents flexible, des modes de mise en forme personnalisables, des paramètres de niveau de conformité, des métadonnées de fuseau horaire et une gestion intelligente des styles. API reçoit le contenu des documents via REST API appels, utilisant Base64 Encodage pour une transmission sécurisée. Grâce à la prise en charge de la fusion illimitée de documents et à un contrôle total du comportement de fusion, cette solution est idéale pour l'assemblage de documents, la consolidation de rapports et les flux de travail de gestion de contenu.
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
- Prise en charge de plusieurs documentsFusionnez un nombre illimité de documents en un seul.
- Structure de tableau simple: Tableau facile à utiliser de Base64-contenu du document encodé
- Fusion ordonnéeDocuments fusionnés dans l'ordre où ils apparaissent dans le tableau
- Concept de document de baseLe premier document sert de base à la fusion.
- Prise en charge de plusieurs formatsFusionnez des documents Word, des PDF et d'autres formats pris en charge.
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 fusion de documents sont effectuées via un point de terminaison unique :
- Méthode: POST
- Point final :
office/ApiV2Word/MergeDocuments
REST API Paramètres
Liste complète des paramètres pour la fusion 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. documents Le tableau doit contenir au moins un document.
Paramètres requis
| Paramètre | Taper | Description | Exemple |
|---|---|---|---|
| documents* | Array | Tableau d'objets documents à fusionner. Doit contenir au moins un document. Chaque objet doit avoir nom de fichier (chaîne de caractères) et docContent (Base64 Les documents sont fusionnés dans l'ordre de leur apparition dans le tableau. Champs optionnels par document : position de tri (entier), mode de format (chaîne) | [{ "filename": "doc1.docx", "docContent": "base64..." }, { "filename": "doc2.docx", "docContent": "base64..." }] |
Paramètres optionnels
| Paramètre | Taper | Description | Exemple |
|---|---|---|---|
| options de fusion | Object | Options de fusion (mise en forme, conformité, etc.). Voir le modèle du plugin pour les propriétés disponibles. | {} |
Ordre de fusion des documents
Les documents sont fusionnés dans l'ordre où ils apparaissent dans le documents tableau:
- Le premier document du tableau devient le document de base
- Tous les documents suivants sont ajouté au document de base dans l'ordre du tableau
Sortir
Le PDF4me Fusionner 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.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
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": "merged-document.docx",
"success": true,
"errorMessage": null
}
Champs de réponse :
- document (chaîne de caractères) : Le document Word fusionné contenant tous les documents d’entrée, encodé comme Base64 chaîne
- nom de fichier (chaîne de caractères) : Nom du fichier Word de sortie
- 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 :
- 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
- Enregistrez ou traitez le fichier Word 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
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 (
documentstableau) - Aucun document à fusionner (tableau de documents vide)
- Invalide Base64 encodage dans le contenu du document
- Documents invalides ou corrompus
- 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
- Échec de la fusion des documents
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, jamais directement de données Word binaires.
Structure de la réponse :
{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": "string or null"
}
En-tête Content-Type :
- Succès:
application/json - Le document Word 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
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);
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 (deux documents) :
{
"documents": [
{ "filename": "doc1.docx", "docContent": "base64EncodedDocument1" },
{ "filename": "doc2.docx", "docContent": "base64EncodedDocument2" }
]
}
Exemple avancé (Fusion de plusieurs documents) :
{
"documents": [
{ "filename": "doc1.docx", "docContent": "base64EncodedDocument1" },
{ "filename": "doc2.docx", "docContent": "base64EncodedDocument2" },
{ "filename": "doc3.docx", "docContent": "base64EncodedDocument3" }
],
"mergeOptions": {}
}
Exemples de code
Le PDF4me Fusionner 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#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
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
- Assemblage contractuel: Combiner les sections du contrat en documents juridiques complets
- Consolidation des mémoires juridiquesFusionner plusieurs sections de résumés en résumés juridiques complets
- Documentation de conformité: Consolider les documents de conformité pour les soumissions réglementaires
- Assemblage des documents clients: Regrouper les documents spécifiques au client en ensembles complets
Cas d'utilisation en entreprise
- Assemblée de proposition: Combiner les sections de la proposition en propositions complètes pour le client
- Consolidation des supports marketingFusionner les documents marketing pour les campagnes
- Assemblée de présentation des ventesCombiner les sections de présentation en présentations complètes
- Assemblage des livrables du clientConsolider les documents spécifiques au client
Cas d'utilisation dans le domaine de l'éducation et de la recherche
- Assemblage de rapports médicaux: Combiner les sections du rapport médical en rapports patients complets
- Documentation du protocoleFusionner les sections de protocole en protocoles médicaux complets
- Documentation de rechercheConsolider les documents de recherche pour les rapports d'étude
- Manuel de conformité Assemblage: Combiner les documents de conformité en matière de soins de santé
Cas d'utilisation dans le secteur financier et bancaire
- Assemblée des rapports financiersFusionner les sections des rapports financiers en rapports complets
- Documentation d'auditConsolider les documents d'audit pour des rapports d'audit complets
- Consolidation budgétaireFusionner les sections budgétaires de différents départements
- Assemblage de dépôt réglementaireFusionner les documents réglementaires en vue de leur soumission