Ajouter un filigrane à Word

PDF4me Ajouter un filigrane à Word est un REST point de terminaison qui appose un filigrane d'image derrière le texte de chaque page d'un Word document. POST le fichier .docx et l'image du filigrane comme Base64 à office/ApiV2Word/AddWatermark, ajuster l'échelle, la transparence et l'alignement, puis décoder le fichier filigrané à partir du JSON réponse. PNG, JPG, JPEGLes images aux formats BMP et GIF sont prises en charge.

Que fait ce point de terminaison ?

Il faut Word Ce document contient une image, mais le résultat est le même document avec l'image apposée en arrière-plan de chaque section : un logo, une mention « CONFIDENTIEL », un tampon « BROUILLON ». Vous contrôlez la taille (en points précis ou par facteur d'échelle), la transparence (à 50 %) et le positionnement (centré ou en haut à gauche). La réponse est : JSON avec pour résultat Base64 contenu.

Articles de blog connexes

Il n'y a pas encore d'article de blog consacré à cette fonctionnalité — à venir prochainement.

En attendant, n'hésitez pas à consulter le blog de PDF4me pour découvrir des tutoriels et des procédures de travail adaptés à toutes les plateformes.

Consultez le blog →

Authentification de votre API Demande

Chaque PDF4me REST L'appel doit inclure votre API clé dans le Authorization En-tête : Authentification de base. Récupérez ou renouvelez votre clé depuis le tableau de bord développeur.

Get your API Key

Point de terminaison

POSToffice/ApiV2Word/Ajouter un filigrane

facteur URLhttps://api.pdf4me.com/office/ApiV2Word/AddWatermark

Informations importantes à ne pas manquer

La réponse est Base64 JSON, pas le fichier

Le document filigrané est renvoyé sous forme de Base64 une chaîne à l'intérieur d'un JSON corps avec fileName, success, et message d'erreurVeuillez le décoder avant de l'enregistrer ; la réponse brute n'est pas un fichier .docx valide.

Échelle de remplacement de la largeur et de la hauteur

La priorité de dimensionnement est exacte largeur/hauteur en points d'abord, puis échelle, puis la taille originale de l'image. N'envoyez qu'une seule dimension ; l'autre sera calculée pour conserver les proportions.

Derrière le texte, dans chaque section

L'image est apposée en arrière-plan du contenu du document, dans toutes les sections et tous les en-têtes, afin que le texte reste lisible. Une image transparente PNG plus semiTransparent : vrai donne l'aspect classique d'un tampon discret.

HTTP installation

Méthode: POST
URL: https://api.pdf4me.com/office/ApiV2Word/AddWatermark
Type de contenu : application/json
Authorization: Basique <votre PDF4me API clé>

La réponse est : JSON: vérifiez le success drapeau, puis Base64-décoder le contenu du document renvoyé et l'enregistrer avec un .docx extension.

Comment fonctionne la priorité de dimensionnement des filigranes ?

Il existe trois paramètres de dimensionnement, strictement hiérarchisés. API utilise l'entrée prioritaire que vous envoyez et ignore le reste.

Dimensionnement des entrées par rapport au comportement	Quand cela s'applique	Ce que le filigrane obtient
`width` et `height` (points)	Priorité maximale ; prévaut `scale` lorsqu'il est présent	Exactement les dimensions que vous spécifiez. Une seule dimension permet de conserver le rapport hauteur/largeur.
`scale` (0,1 à 10,0)	Utilisé uniquement lorsqu'aucune largeur ni hauteur n'est envoyée	Taille de l'image originale multipliée par le facteur : 0,5 correspond à la moitié de la taille, 2,0 à son double.
Aucun des deux n'a envoyé	Retomber	Dimensions originales en pixels de l'image téléchargée

API champs corporels

Paramètre	Requis	Taper	Ce que cela fait	Exemple
`document`	Required	object	Document reference carrying Name, the Word filename with its .docx extension.	`{ "Name": "document.docx" }`
`docContent`	Required	string	Base64-encoded bytes of the Word document to watermark.	`UEsDBBQABgAIAAAA...`
`watermarkFileName`	Required	string	Watermark image filename with its extension. PNG, JPG, JPEG, BMP, and GIF are supported.	`watermark.png`
`watermarkFileContent`	Required	string	Base64-encoded bytes of the watermark image. A PNG with a transparent background gives the cleanest behind-text result.	`iVBORw0KGgo...`
`scale`	Optional	number	Scale factor from 0.1 to 10.0 applied to the original image size. Default 1.0. Ignored when width or height is sent.	`1.5`
`semiTransparent`	Optional	boolean	true renders the watermark at 50 percent opacity for a subtle stamp; false (default) keeps full opacity.	`true`
`width`	Optional	number	Exact watermark width in points. Overrides scale. If height is omitted it is calculated to keep the aspect ratio.	`200`
`height`	Optional	number	Exact watermark height in points. Overrides scale. If width is omitted it is calculated to keep the aspect ratio.	`150`
`alignImage`	Optional	boolean	true (default) centers the watermark on the page; false aligns it top-left within the margins.	`true`
`cultureName`	Optional	string	Culture code applied to document metadata during processing, for example en-US or de-DE.	`en-US`

Exemples de charges utiles

Demande minimale (champs obligatoires uniquement)

{
 "document": { "Name": "document.docx" },
 "docContent": "UEsDBBQABgAIAAAA...",
 "watermarkFileName": "watermark.png",
 "watermarkFileContent": "iVBORw0KGgoAAAANSUhEUgAA..."
}

Dimensionné, semi-transparent, centré

{
 "document": { "Name": "contract-draft.docx" },
 "docContent": "UEsDBBQABgAIAAAA...",
 "watermarkFileName": "confidential.png",
 "watermarkFileContent": "iVBORw0KGgoAAAANSUhEUgAA...",
 "width": 200,
 "height": 150,
 "semiTransparent": true,
 "alignImage": true,
 "cultureName": "en-US"
}

Conseils pour la collecte par le facteur

Headers

Content-Type: application/json + Authorization: Basic <apiKey>.

Body

raw JSON with TWO Base64 fields: docContent for the Word file and watermarkFileContent for the image. Both must be encoded separately.

Sizing

Send width/height OR scale, not both. If you send both, the exact dimensions win and scale is silently ignored.

Response

JSON with a success flag and Base64 document content. Decode the document field before saving as .docx.

Exemple curl

curl -X POST https://api.pdf4me.com/office/ApiV2Word/AddWatermark \
 -H "Content-Type: application/json" \
 -H "Authorization: Basic YOUR_API_KEY" \
 -d '{
 "document": { "Name": "document.docx" },
 "docContent": "'"$(base64 -w 0 document.docx)"'",
 "watermarkFileName": "watermark.png",
 "watermarkFileContent": "'"$(base64 -w 0 watermark.png)"'",
 "semiTransparent": true
 }' \
 --output response.json

Que signifie le API retour?

UN JSON résultat contenant le document filigrané comme Base64.

Champ	Taper	Ce qu'il contient
`document`	String (Base64)	The watermarked Word document content. Decode to bytes and save with a .docx extension.
`fileName`	String	Output filename for the watermarked document.
`success`	Boolean	true when watermarking succeeded. Check this before decoding content.
`errorMessage`	String	Populated when success is false: invalid Base64, a corrupted document or image, or out-of-range sizing values.

Comportement asynchrone (202) Accepted avec un sondage URL dans le Location L'en-tête est contrôlé par la configuration du serveur, et non par un paramètre du corps de la requête. Lorsqu'un code 202 arrive, interrogez le serveur. Location URL avec GET demandes jusqu'à ce que vous en receviez 200 OK avec le même JSON forme.

Exemples de code

Word Les points de terminaison de bureau ne sont pas encore couverts par des dossiers d'exemples par point de terminaison dans le référentiel d'exemples ; il contient le modèle de requête utilisé par chaque PDF4me famille de points de terminaison :

View API Samples Repository

FAQ

Which image formats can I use as a Word watermark?+

PNG, JPG, JPEG, BMP, and GIF. A PNG with a transparent background gives the cleanest result because the image is stamped behind the document text on every page.

Is the response the Word file itself?+

No. The API returns JSON containing the watermarked document as a Base64 string plus fileName, success, and errorMessage fields. Decode the document field to bytes before saving as .docx.

What happens if I send both scale and width or height?+

Width and height win. Exact dimensions in points always override the scale factor. If you provide only one of the two, the other is calculated automatically to preserve the image aspect ratio.

Does the watermark cover the document text?+

No. The watermark is placed behind the text, in every section of the document, so the content stays readable. Set semiTransparent to true for a subtle 50 percent opacity effect.

Can this endpoint add text watermarks like DRAFT or CONFIDENTIAL?+

This endpoint stamps images. For text stamps use the Add Text Watermark to Word endpoint, or render your text as a transparent PNG and pass it here as the watermark image.

Where does the watermark appear in the document?+

Across all sections and their headers, behind the content. alignImage true centers it on the page; false places it top-left within the margins. Per-page or per-range placement is not part of this action.

Does adding a watermark protect the document from editing?+

No. A watermark is a visual marker, not a security control; anyone who can edit the file can remove it. To restrict editing or require a password, chain the Secure Word Document endpoint after this one.

Pourquoi ajouter des filigranes via API au lieu de manuellement dans Word?

La voie manuelle est insertion d'un filigrane d'image dans WordOuvrir chaque fichier, onglet Conception, Filigrane, Filigrane personnalisé, sélectionner l'image, enregistrer, répéter. Cette méthode n'est pas adaptée à un processus contractuel qui appose un tampon sur chaque brouillon sortant. API applique le même tampon de fond de texte qu'une requête déterministe par fichier, avec une taille de point exacte que le Word La boîte de dialogue ne s'affiche pas. Le résultat est standard. tatouage numérique pour le marquage de provenance et d'état, appliqué à la vitesse de la chaîne de production.