Aggiungi filigrana a Word

PDF4me Aggiungi filigrana a Word è un REST endpoint che imprime una filigrana immagine dietro il testo di ogni pagina in un Word documento. POST il file .docx e l'immagine della filigrana come Base64 A office/ApiV2Word/AddWatermark, regola scala, trasparenza e allineamento, quindi decodifica il file con filigrana dal JSON risposta. PNG, JPG, JPEGSono supportate le immagini BMP e GIF.

Cosa fa questo endpoint

Prende un Word documento più un'immagine e restituisce lo stesso documento con quell'immagine stampata dietro il testo di ogni sezione: un logo, un banner RISERVATO, un timbro BOZZA. È possibile controllare le dimensioni (punti esatti o un fattore di scala), un'opzione di trasparenza al 50% e il posizionamento al centro o in alto a sinistra. La risposta è JSON con il risultato come Base64 contenuto.

Autenticazione del tuo API Richiesta

Ogni PDF4me REST la chiamata deve includere il tuo API chiave nel Authorization Intestazione come autenticazione di base. Ottieni o ruota la tua chiave dalla dashboard dello sviluppatore.

Get your API Key

Punto finale

POSTufficio/ApiV2Word/AggiungiFiligrana

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

Informazioni importanti da non perdere

La risposta è Base64 JSON, non il file

Il documento con filigrana viene restituito come un Base64 corda all'interno di un JSON corpo con fileName, success, E messaggio di erroreDecodifica il file prima di salvarlo; la risposta non elaborata non è un file .docx valido.

Larghezza e altezza sovrascrivono la scala

La priorità delle dimensioni è esatta larghezza/altezza prima a punti, poi scala, quindi la dimensione originale dell'immagine. Invia solo una dimensione e l'altra viene calcolata per mantenere le proporzioni.

Dietro il testo, in ogni sezione

L'immagine è stampata dietro il contenuto del documento in tutte le sezioni e intestazioni, in modo che il testo rimanga leggibile. Un trasparente PNG altro semiTrasparente: vero conferisce il classico aspetto di un timbro discreto.

HTTP impostare

Metodo: POST
URL: https://api.pdf4me.com/office/ApiV2Word/AddWatermark
Tipo di contenuto: applicazione/json
Authorization: Base <il tuo PDF4me API chiave>

La risposta è JSON: controlla il success bandiera, poi Base64-decodifica il contenuto del documento restituito e salvalo con un .docx estensione.

Come funziona la priorità di dimensionamento della filigrana?

Esistono tre input di dimensionamento e sono rigorosamente classificati. Il API Utilizza l'input con la priorità più alta effettivamente inviato e ignora il resto.

Dimensionamento dell'input rispetto al comportamento	Quando si applica	Cosa ottiene la filigrana
`width` E `height` (punti)	Massima priorità; prevale sulle eccezioni. `scale` quando presente	Esattamente le dimensioni che hai specificato. Una sola dimensione mantiene il rapporto d'aspetto
`scale` (da 0,1 a 10,0)	Utilizzato solo quando non vengono inviate informazioni su larghezza o altezza.	La dimensione originale dell'immagine moltiplicata per il fattore: 0,5 è metà dimensione, 2,0 è il doppio
Nessuno dei due ha inviato	Ricaderci	Le dimensioni originali in pixel dell'immagine caricata

API campi corporei

Parametro	Necessario	Tipo	Cosa fa	Esempio
`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`

Esempi di carichi utili

Richiesta minima (solo campi obbligatori)

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

Di dimensioni adeguate, semitrasparenti, centrati

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

Consigli per la raccolta del postino

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.

esempio di riccio

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

Che cosa significa il API ritorno?

UN JSON risultato che porta il documento con filigrana come Base64.

Campo	Tipo	Cosa contiene
`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.

Comportamento asincrono (202 Accepted con un sondaggio URL nel Location l'intestazione) è controllata dalla configurazione del server, non da un parametro del corpo della richiesta. Quando arriva un 202, interroga il Location URL con GET richieste fino a quando non ne ricevi 200 OK con lo stesso JSON forma.

Esempi di codice

Word Gli endpoint dell'ufficio non sono ancora coperti da cartelle di esempio per endpoint nel repository degli esempi; contiene il modello di richiesta utilizzato da ogni PDF4me Famiglia di endpoint:

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.

Perché aggiungere filigrane tramite API invece di manualmente in Word?

Il percorso manuale è inserire una filigrana di immagine in Word: apri ogni file, scheda Progettazione, Filigrana, Filigrana personalizzata, scegli l'immagine, salva, ripeti. Questo non è scalabile a una pipeline di contratti che timbra ogni bozza in uscita. API applica lo stesso timbro dietro il testo come una richiesta deterministica per file, con dimensionamento esatto dei punti che il Word la finestra di dialogo non viene esposta. Il risultato è standard filigrana digitale Per la marcatura di provenienza e stato, applicata alla velocità della pipeline.