Optimisation de document - Optimisation de document API
PDF4me Optimiser le document vous permet d'optimiser les documents Word en termes de taille et de performances grâce à trois niveaux de compression différents et à des techniques d'optimisation complètes. API Ce service traite les fichiers Word et réduit leur taille, compresse les images, nettoie le contenu, normalise la mise en forme et supprime les informations personnelles. API reçoit le contenu des documents Word via REST API appels, utilisant Base64 Encodage pour une transmission sécurisée. Prenant en charge les niveaux d'optimisation Faible, Moyen et Élevé, permettant une réduction de la taille des fichiers de 0 à 90 %, cette solution est idéale pour la préparation de documents, l'optimisation du stockage et l'amélioration des performances 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
- Optimisation maximaleProfil de compression maximale pour une réduction maximale de la taille des fichiers
- Réduction de la taille des fichiersObtenez une réduction de la taille des fichiers de 80 à 90 % grâce à l'optimisation maximale.
- Compression d'imageOptimisation intelligente de l'image avec préservation de la qualité
- Nettoyage de contenuSupprimez les macros, les commentaires et le contenu masqué inutilisés.
- Normalisation de la mise en forme: Nettoyer les mises en forme redondantes et les styles inutilisés
- Suppression des informations personnellesSupprimer les informations sur l'auteur, le responsable et l'entreprise
- Optimisation des policesNormaliser les polices et supprimer les propriétés de police inutiles
- Amélioration de la compatibilitéOptimiser les documents pour la compatibilité avec Word 2016
REST API Point de terminaison
Le PDF4me REST API utilise la norme HTTP méthodes d'interaction avec les ressources. Toutes les opérations d'optimisation de documents sont effectuées via un point de terminaison unique :
- Méthode: POST
- Point final :
office/ApiV2Word/OptimizeDocument
REST API Paramètres
Liste complète des paramètres pour l'optimisation du document 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. Le niveau d'optimisation détermine l'agressivité des techniques d'optimisation appliquées.
Paramètres requis
| Paramètre | Taper | Description | Exemple |
|---|---|---|---|
| document* | Object | Référence du document. Doit contenir Nom (chaîne de caractères) : Nom du fichier Word avec l'extension .docx | { "Name": "document.docx" } |
| docContent* | Base64 | Contenu du document Word encodé en Base64Le document original n'a pas été modifié ; une nouvelle version optimisée a été créée. | UEsDBBQABgAIAAAA... |
Paramètres optionnels
| Paramètre | Taper | Description | Exemple |
|---|---|---|---|
| niveau d'optimisation | String | Niveau d'optimisation (par exemple, Faible, Moyen, Max). Max - Compression maximale (environ 80-90 %). Contrôle l'agressivité des techniques d'optimisation. | "Max" |
| wordVersion | String | Version Word cible pour la compatibilité | null |
| nom de la culture | String | Code culturel pour le traitement des documents (par exemple, "en-US", "de-DE", "fr-FR") | en-US |
Profil d'optimisation
Le Max Le profil d'optimisation assure une compression maximale :
- Réduction de la taille des fichiers: 80-90%
- Qualité d'image: Optimisé pour la taille
- Mise en formeNettoyage agressif
- Commentaires: Supprimé
- Révisions: Supprimé
- Informations personnelles: Supprimé
- Macros: Supprimé
- Styles inutilisés: Supprimé
- Contenu caché: Supprimé
Sortir
Le PDF4me Optimiser le document 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": "document.docx",
"success": true,
"errorMessage": null
}
Champs de réponse :
- document (chaîne de caractères) : Le document Word optimisé avec une taille de fichier réduite, 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 (
documentavecNom,docContent) - Invalide Base64 encodage dans
docContent - Document Word invalide ou corrompu
- Niveau d'optimisation 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
- Échec de l'optimisation du document
- Erreur lors de l'application des paramètres de compression
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 (optimisation maximale par défaut) :
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"optimizationLevel": "Max"
}
Exemple avancé (avec champs facultatifs) :
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"optimizationLevel": "Max",
"wordVersion": null,
"cultureName": "en-US"
}
Exemples de code
Le PDF4me Optimiser le document 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# Mise en œuvre pour l'optimisation 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
- Distribution de documentsOptimiser les documents juridiques pour la distribution aux clients
- Dépôt public: Préparer les documents pour les dépôts publics devant le tribunal
- ArchivageOptimiser les documents juridiques en vue de leur conservation à long terme
- Documents de conformité: Nettoyer les documents en vue des soumissions réglementaires
Cas d'utilisation en entreprise
- Distribution des propositionsOptimiser les propositions pour la livraison au client
- Partage de matériel marketingOptimiser les documents marketing destinés à la diffusion publique
- Optimisation de la présentationOptimiser les présentations pour la diffusion par courriel
- Préparation des livrables clientsNettoyer les documents en vue de leur livraison au client
Cas d'utilisation dans le domaine de l'éducation et de la recherche
- Distribution des rapports des patientsOptimiser les rapports médicaux pour un partage sécurisé
- Documentation de rechercheOptimiser les documents de recherche en vue de leur publication
- Partage de protocoleOptimiser les protocoles médicaux pour la distribution au sein du département
- Documentation de conformité: Nettoyer les documents en vue des soumissions réglementaires
Cas d'utilisation dans le secteur financier et bancaire
- Distribution des rapports financiersOptimiser les rapports financiers pour leur diffusion aux parties prenantes
- Documentation d'auditNettoyer les documents d'audit en vue de leur partage externe
- Partage des documents budgétairesOptimiser les documents budgétaires pour la distribution au sein du département
- Dépôt réglementairePréparer les documents pour les soumissions réglementaires