Ajouter un filigrane de texte à Word - Filigrane de texte API
PDF4me Ajouter un filigrane de texte à Word vous permet d'ajouter des filigranes de texte personnalisables aux documents Word grâce à un contrôle complet du style et du positionnement. API Ce service traite les fichiers Word et ajoute des filigranes textuels avec un contrôle total sur le contenu du texte, la police, la taille des caractères, les couleurs, les angles de rotation, les préréglages d'orientation et les niveaux de transparence. 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 des étiquettes de sécurité, des éléments de marque, des mentions de confidentialité et des indicateurs d'état, cette solution est idéale pour la sécurité des documents, la protection de la marque et les flux de travail d'indication d'état.
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 des filigranes de texteFiligranes de texte professionnels avec tout contenu textuel personnalisé
- Personnalisation des policesContrôle total sur la famille de polices, le nom de la police et la taille de la police
- Options de couleurPrise en charge des couleurs nommées, des codes hexadécimaux, des valeurs RVB et des nombres hexadécimaux à 3 chiffres
- Contrôle de rotation: Angles de rotation personnalisés (0-360°) ou préréglages d'orientation prédéfinis
- Options de transparenceEffets de filigrane semi-transparents ou totalement opaques
- dimensionnement automatique: Dimensionnement intelligent basé sur la longueur du texte et la taille de la police
- Application à l'échelle du documentFiligrane appliqué à toutes les sections et à tous les en-têtes
- Placement du texte derrièreFiligrane placé derrière le contenu du document
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'ajout de filigrane textuel sont effectuées via un point de terminaison unique :
- Méthode: POST
- Point final :
office/ApiV2Word/AddTextWatermark
REST API Paramètres
Liste complète des paramètres pour l'ajout d'un filigrane de texte à Word 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 et doivent être fournis pour le API pour fonctionner correctement.
Paramètres requis
| Paramètre | Taper | Description | Exemple |
|---|---|---|---|
| document* | Object | Description du document. Doit inclure Nom (chaîne de caractères) : nom du fichier Word de sortie avec l’extension .docx | { "Name": "document.docx" } |
| docContent* | Base64 | Contenu du document Word encodé en Base64 | UEsDBBQABgAIAAAA... |
| filigraneTexte* | String | Texte à afficher en filigrane. Obligatoire : ne peut être nul, vide ou composé uniquement d’espaces. Exemples : « CONFIDENTIEL », « BROUILLON », « APPROUVÉ ». | CONFIDENTIAL |
Paramètres optionnels
| Paramètre | Taper | Description | Exemple |
|---|---|---|---|
| famille de polices | String | Police de caractères pour le texte du filigrane. Courantes : « Arial », « Calibri », « Times New Roman », « Helvetica ». Par défaut : « Arial ». | Arial |
| taille de police | Number (double) | Taille de la police en points (de 1 à 1000). Par défaut : 72 | 72 |
| couleur de police | String | Couleur du texte. Nommée : « Rouge », « Bleu », « Gris ». Hexadécimal : « #FF0000 », « FF0000 ». RGB : « RGB(255,0,0) ». Par défaut : « #808080 » | #FF0000 |
| semi-transparent | Boolean | Transparence. true = opacité 50%, false = 100 % (par défaut) | true |
| rotation | Number (double) | Angle de rotation personnalisé (0-360°). Valeur par défaut : 0 | 45 |
| nom de police | String | Nom de la police pour le texte du filigrane | Arial |
| orientation | String | Orientation prédéfinie : Horizontal (0°), Verticale (90°), Diagonale (45°), À l'envers (180°). Priorise la rotation si elle est fournie. | Diagonal |
| nom de la culture | String | Code culturel (par exemple, « en-US », « de-DE », « fr-FR »). Par défaut : nul | en-US |
Options d'orientation du texte
L'orientation du texte du filigrane suit la priorité de ce paramètre :
- orientation - Si fourni, utilise un angle d'orientation prédéfini
- rotation - Si l'orientation n'est pas fournie, utilise un angle de rotation personnalisé
- Défaut - Si aucune valeur n'est fournie, utilise 0° (horizontal)
Orientations prédéfinies :
- Horizontal: 0° (par défaut)
- Verticale: 90°
- Diagonale: 45°
- À l'envers: 180°
Sortir
Le PDF4me Ajouter un filigrane de texte à Word REST API renvoie un JSON réponse (ApiV2WordApiCallRes). En cas de succès, la API renvoie le document Word sous forme de Base64chaîne encodée dans le document champ, et non sous forme de données binaires.
- Success Response
- Error Responses
- Response Format Details
Réponse réussie
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 avec filigrane de texte appliqué, encodé comme Base64
- nom de fichier (chaîne de caractères) : Nom du fichier Word de sortie
- succès (booléen) : Indique si l'opération a réussi.
- message d'erreur (chaîne de caractères) : Message d’erreur en cas d’échec ; sinon, valeur nulle.
Mode d'emploi :
- Vérifier
success; si vrai, extraire ledocumentchamp du JSON réponse - Décodez le Base64 chaîne permettant d'obtenir les données binaires d'un document Word
- Enregistrez ou traitez le fichier Word en utilisant
fileName
Exemple (JavaScript) :
const response = await fetch(url, options);
const data = await response.json();
if (!data.success) throw new Error(data.errorMessage);
const wordBytes = atob(data.document);
// Save or process wordBytes
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 (
document,docContent,filigraneTexte) filigraneTextene peut pas être nul, vide ou composé uniquement d'espaces blancs.- Invalide Base64 encodage dans
docContent - Document Word invalide ou corrompu
- Taille de police invalide (doit être comprise entre 1 et 1000)
- Angle de rotation 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 d'ajout de filigrane de texte
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 réponse (ApiV2WordApiCallRes) :
{
"document": "string", // Base64-encoded Word document content
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": 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(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 simple (champs obligatoires uniquement) :
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"watermarkText": "CONFIDENTIAL"
}
Exemple avancé (avec champs facultatifs) :
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"watermarkText": "CONFIDENTIAL",
"orientation": "Diagonal",
"fontFamily": "Arial",
"fontSize": 72,
"fontColor": "#FF0000",
"semiTransparent": true,
"cultureName": "en-US"
}
Exemple de rotation personnalisée :
{
"document": { "Name": "document.docx" },
"docContent": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"watermarkText": "DRAFT",
"fontFamily": "Times New Roman",
"fontSize": 48,
"fontColor": "Gray",
"rotation": 45,
"semiTransparent": true
}
Exemples de code
Le PDF4me Ajouter un filigrane de texte à Word 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# Exemple (CSharp)
Complet C# Implémentation pour ajouter des filigranes de texte aux 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
- Documents confidentiels: Filigrane sur les documents juridiques avec la mention « CONFIDENTIEL »
- Projets de contrats: Marquer les projets d'accords avec le statut « PROJET - EN COURS D'EXAMEN »
- Étiquettes de privilègeAppliquer les filigranes de texte « PRIVILÈGE AVOCAT-CLIENT »
- Marqueurs d'état: Indiquer le statut « APPROUVÉ » ou « EN COURS D'EXAMEN »
Cas d'utilisation en entreprise
- Grilles tarifairesAjouter la mention « TARIFS CONFIDENTIELS » en filigrane aux grilles tarifaires
- Propositions: Apposez un filigrane sur les propositions clients comportant la mention « © 2024 [Société] »
- Rapports internes: Indiquer que les analyses internes sont réservées à un usage interne.
- Documents de projet: Indiquer le statut « BROUILLON – NE PAS DIFFUSER »
Cas d'utilisation dans le domaine de l'éducation et de la recherche
- Données du patientAjouter un filigrane « PROTÉGÉ HIPAA » aux dossiers des patients
- Rapports médicauxRésultats de laboratoire avec filigrane et mention « MÉDICAL CONFIDENTIEL »
- Données de rechercheAppliquer le filigrane « DONNÉES DE RECHERCHE - CONFIDENTIELLES »
- Réclamations d'assurance: Apposer la mention « CONFIDENTIALITÉ PROTÉGÉE » sur les documents d'assurance
Cas d'utilisation dans le secteur financier et bancaire
- Garantie des états financiersAjouter la mention « CONFIDENTIEL » en filigrane aux rapports financiers
- Projets de budget: Documents budgétaires provisoires filigranés avec le statut « PROJET »
- Documents d'auditAppliquer le filigrane « COPIE D'AUDIT » aux livrables d'audit
- Rapports clientsAjouter un filigrane « © 2024 [Société] » aux rapports destinés aux clients