Adicionar marca d'água Word

PDF4me Adicionar marca d'água Word é um REST endpoint que insere uma marca d'água de imagem atrás do texto de cada página em um Word documento. POST o arquivo .docx e a imagem da marca d'água como Base64 para office/ApiV2Word/AddWatermarkAjuste a escala, a transparência e o alinhamento e, em seguida, decodifique o arquivo com marca d'água. JSON resposta. PNG, JPG, JPEGSão suportadas imagens nos formatos .bmp, BMP e GIF.

O que este endpoint faz

Leva um Word O documento é inserido juntamente com uma imagem e retorna o mesmo documento com essa imagem sobreposta ao texto de cada seção: um logotipo, uma faixa CONFIDENCIAL, um carimbo de RASCUNHO. Você controla o tamanho (pontos exatos ou um fator de escala), uma opção de transparência de 50% e o posicionamento centralizado ou no canto superior esquerdo. A resposta é JSON com o resultado sendo Base64 contente.

Autenticando seu API Solicitar

Todo PDF4me REST A chamada deve incluir o seu API chave no Authorization Defina o cabeçalho como autenticação básica. Obtenha ou altere sua chave no painel do desenvolvedor.

Get your API Key

Ponto final

POSTescritório/ApiV2Word/AdicionarMarcaD'água

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

Fatos importantes que você não deve perder

A resposta é Base64 JSON, não o arquivo

O documento com marca d'água retorna como um Base64 corda dentro de um JSON corpo com fileName, success, e mensagem de erroDecodifique antes de salvar; a resposta bruta não é um arquivo .docx válido.

A largura e a altura substituem a escala.

A prioridade de dimensionamento é exata. largura/altura Primeiro em pontos, depois escalaEm seguida, o tamanho original da imagem. Envie apenas uma dimensão e a outra será calculada para manter a proporção.

Por trás do texto, em cada seção

A imagem é impressa atrás do conteúdo do documento em todas as seções e cabeçalhos, mantendo o texto legível. Um fundo transparente. PNG mais semitransparente: verdadeiro Proporciona o visual clássico de carimbo discreto.

HTTP configurar

Método: POST
URL: https://api.pdf4me.com/office/ApiV2Word/AddWatermark
Tipo de conteúdo: aplicativo/json
Authorization: Básico <seu PDF4me API chave>

A resposta é JSON: verifique o success bandeira, então Base64-decodificar o conteúdo do documento retornado e salvá-lo com um .docx extensão.

Como funciona a prioridade de dimensionamento da marca d'água?

Existem três parâmetros de dimensionamento, e eles são rigorosamente classificados. API Usa a entrada de maior prioridade que você realmente enviar e ignora o resto.

Dimensionamento de entrada versus comportamento	Quando se aplica	O que a marca d'água recebe
`width` e `height` (pontos)	Prioridade máxima; substitui `scale` quando presente	Exatamente as dimensões que você especificar. Uma única dimensão mantém a proporção.
`scale` (0,1 a 10,0)	Utilizado apenas quando não forem enviadas largura ou altura.	Tamanho original da imagem multiplicado pelo fator: 0,5 é metade do tamanho, 2,0 é o dobro.
Nenhum dos dois enviou	Cair pra trás	As dimensões originais em pixels da imagem carregada.

API campos corporais

Parâmetro	Obrigatório	Tipo	O que faz	Exemplo
`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`

Exemplos de cargas úteis

Solicitação mínima (somente campos obrigatórios)

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

Dimensionado, semitransparente, centralizado

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

Dicas de coleta do carteiro

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.

exemplo de 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

O que significa o API retornar?

A JSON resultado contendo o documento com marca d'água como Base64.

Campo	Tipo	O que contém
`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 assíncrono (202 Accepted com uma pesquisa URL no Location O cabeçalho) é controlado pela configuração do servidor, não por um parâmetro do corpo da requisição. Quando um código 202 chega, consulte o Location URL com GET Faça solicitações até receber 200. OK com o mesmo JSON forma.

Exemplos de código

Word Os endpoints do Office ainda não estão cobertos por pastas de exemplo específicas para cada endpoint no repositório de exemplos; ele contém o padrão de solicitação usado por todos. PDF4me família de endpoints:

View API Samples Repository

Perguntas frequentes

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.

Por que adicionar marcas d'água via API em vez de manualmente em Word?

O percurso manual é Inserindo uma marca d'água de imagem em WordAbrir cada arquivo, aba Design, Marca d'água, Marca d'água personalizada, escolher a imagem, salvar, repetir. Isso não é escalável para um fluxo de trabalho de contratos que carimba cada rascunho enviado. API Aplica o mesmo carimbo de texto subjacente que uma solicitação determinística por arquivo, com dimensionamento de ponto exato que o Word O diálogo não é exposto. O resultado é padrão. marca d'água digital Para fins de rastreabilidade e marcação de status, aplicado em tempo real.