Adicionar uma marca-d’água de texto a um PDF
Carimbe até três linhas de texto nas páginas de um PDF, com controle sobre o modelo, a cor e a opacidade.
Adicione uma marca-d’água de texto a um documento PDF. Forneça até três linhas
de texto e controle o modelo, a cor, a transparência e a margem. Por padrão, a
marca-d’água é carimbada em todas as páginas. Use o parâmetro
pages para direcionar um subconjunto. A API é
stateless: seu documento é processado na própria região e nunca é armazenado.
Endpoint
/v1/add_text_watermarkDisponível em todas as regiões. Consulte Regiões e residência de dados para o roteamento e a residência de dados.
| Região | URL |
|---|---|
| Global | https://api.pdfblocks.com/v1/add_text_watermark |
| Estados Unidos | https://us.api.pdfblocks.com/v1/add_text_watermark |
| HIPAA Estados Unidos | https://hipaa.api.pdfblocks.com/v1/add_text_watermark |
| União Europeia | https://eu.api.pdfblocks.com/v1/add_text_watermark |
| Reino Unido | https://uk.api.pdfblocks.com/v1/add_text_watermark |
| Canadá | https://ca.api.pdfblocks.com/v1/add_text_watermark |
| Austrália | https://au.api.pdfblocks.com/v1/add_text_watermark |
| Japão | https://jp.api.pdfblocks.com/v1/add_text_watermark |
| Índia | https://in.api.pdfblocks.com/v1/add_text_watermark |
| Brasil | https://br.api.pdfblocks.com/v1/add_text_watermark |
Autenticação
Autentique cada requisição com sua chave de API secreta no cabeçalho
X-API-Key, por HTTPS. Crie e gerencie suas chaves no
dashboard. Consulte
Autenticação para mais detalhes.
Requisição
O endpoint aceita um corpo de requisição multipart/form-data.
filefilerequiredO documento PDF de entrada.
line_1stringrequiredA primeira linha do texto da marca-d’água. Máximo de 32 caracteres. Use caracteres latinos padrão.
line_2stringA segunda linha do texto da marca-d’água. Máximo de 32 caracteres.
line_3stringA terceira linha do texto da marca-d’água. Máximo de 32 caracteres.
pagesstringAs páginas a serem carimbadas, escritas como um intervalo de
páginas do tipo 1..3,5. Quando omitido, a
marca-d’água é aplicada a todas as páginas. Máximo de 1.000 caracteres.
templateintegerdefault:1001O modelo da marca-d’água, que define o estilo (preenchido ou contorno) e a orientação.
colorstringdefault:GrayA cor da marca-d’água. Uma entre Red, Blue, Gray ou Black.
transparencyintegerdefault:75O nível de transparência, de 0 (totalmente opaco) a 100 (totalmente
transparente).
margindecimaldefault:1.0A distância, em polegadas, da borda da página até a marca-d’água. 0 ou maior.
Modelos de marca-d’água
Cada template combina um estilo (preenchido ou contorno) com uma
orientação. Passe o identificador para o parâmetro template.
| Modelo | Estilo | Orientação |
|---|---|---|
1001 |
Preenchido | Diagonal, do canto inferior esquerdo ao superior direito (padrão) |
1002 |
Preenchido | Diagonal, do canto superior esquerdo ao inferior direito |
1003 |
Preenchido | Horizontal |
1004 |
Preenchido | Vertical, lida de baixo para cima |
1005 |
Preenchido | Vertical, lida de cima para baixo |
1017 |
Contorno | Diagonal, do canto inferior esquerdo ao superior direito |
1018 |
Contorno | Diagonal, do canto superior esquerdo ao inferior direito |
1019 |
Contorno | Horizontal |
1020 |
Contorno | Vertical, lida de baixo para cima |
1021 |
Contorno | Vertical, lida de cima para baixo |
Veja todos os modelos renderizados em uma página de exemplo no catálogo visual de modelos.
Cores
| Valor | Amostra |
|---|---|
Red |
#C00000 |
Blue |
#005DFF |
Gray |
#545454 |
Black |
#000000 |
Selecionar páginas
O parâmetro pages recebe uma lista separada por vírgulas de números de página
com base 1 e de intervalos. Ele é tratado como um conjunto: a ordem e as
duplicatas são ignoradas, e as páginas são sempre carimbadas na ordem do
documento.
| Padrão | Seleciona |
|---|---|
| (omitir) | Todas as páginas |
1 |
Apenas a primeira página |
1..3,5 |
As páginas 1, 2, 3 e 5 |
2.. |
Da página 2 até a última página |
..-2 |
Da primeira página até a penúltima |
-1 |
A última página |
Consulte Selecionar páginas para a referência completa.
Exemplos
Carimbe uma marca-d’água de duas linhas nas páginas 1 a 3 e 5:
curl https://api.pdfblocks.com/v1/add_text_watermark \
-H 'X-API-Key: your_api_key' \
-F file=@input.pdf \
-F line_1='CONFIDENTIAL' \
-F line_2='ACME, Inc.' \
-F template=1001 \
-F color=Red \
-F pages='1..3,5' \
-o watermarked.pdf# pip install requests
import requests
with open('input.pdf', 'rb') as file:
response = requests.post(
'https://api.pdfblocks.com/v1/add_text_watermark',
headers={'X-API-Key': 'your_api_key'},
files={'file': file},
data={
'line_1': 'CONFIDENTIAL',
'line_2': 'ACME, Inc.',
'template': 1001,
'color': 'Red',
'pages': '1..3,5',
},
)
response.raise_for_status()
with open('watermarked.pdf', 'wb') as output:
output.write(response.content)// Node.js 18+
import { readFile, writeFile } from 'node:fs/promises';
const body = new FormData();
body.set('file', new Blob([await readFile('input.pdf')]), 'input.pdf');
body.set('line_1', 'CONFIDENTIAL');
body.set('line_2', 'ACME, Inc.');
body.set('template', '1001');
body.set('color', 'Red');
body.set('pages', '1..3,5');
const response = await fetch('https://api.pdfblocks.com/v1/add_text_watermark', {
method: 'POST',
headers: { 'X-API-Key': 'your_api_key' },
body,
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
await writeFile('watermarked.pdf', Buffer.from(await response.arrayBuffer()));<?php
$ch = curl_init('https://api.pdfblocks.com/v1/add_text_watermark');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['X-API-Key: your_api_key'],
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => [
'file' => new CURLFile('input.pdf', 'application/pdf'),
'line_1' => 'CONFIDENTIAL',
'line_2' => 'ACME, Inc.',
'template' => '1001',
'color' => 'Red',
'pages' => '1..3,5',
],
]);
$pdf = curl_exec($ch);
if (curl_getinfo($ch, CURLINFO_HTTP_CODE) === 200) {
file_put_contents('watermarked.pdf', $pdf);
}# gem install http
require 'http'
response = HTTP
.headers('X-API-Key' => 'your_api_key')
.post('https://api.pdfblocks.com/v1/add_text_watermark', form: {
file: HTTP::FormData::File.new('input.pdf'),
line_1: 'CONFIDENTIAL',
line_2: 'ACME, Inc.',
template: '1001',
color: 'Red',
pages: '1..3,5',
})
File.write('watermarked.pdf', response.body) if response.status.success?package main
import (
"bytes"
"io"
"mime/multipart"
"net/http"
"os"
)
func main() {
var buf bytes.Buffer
form := multipart.NewWriter(&buf)
file, _ := os.Open("input.pdf")
defer file.Close()
part, _ := form.CreateFormFile("file", "input.pdf")
io.Copy(part, file)
form.WriteField("line_1", "CONFIDENTIAL")
form.WriteField("line_2", "ACME, Inc.")
form.WriteField("template", "1001")
form.WriteField("color", "Red")
form.WriteField("pages", "1..3,5")
form.Close()
req, _ := http.NewRequest("POST", "https://api.pdfblocks.com/v1/add_text_watermark", &buf)
req.Header.Set("Content-Type", form.FormDataContentType())
req.Header.Set("X-API-Key", "your_api_key")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
out, _ := os.Create("watermarked.pdf")
defer out.Close()
io.Copy(out, res.Body)
}using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-API-Key", "your_api_key");
using var form = new MultipartFormDataContent
{
{ new ByteArrayContent(File.ReadAllBytes("input.pdf")), "file", "input.pdf" },
{ new StringContent("CONFIDENTIAL"), "line_1" },
{ new StringContent("ACME, Inc."), "line_2" },
{ new StringContent("1001"), "template" },
{ new StringContent("Red"), "color" },
{ new StringContent("1..3,5"), "pages" },
};
var response = await client.PostAsync(
"https://api.pdfblocks.com/v1/add_text_watermark", form);
response.EnsureSuccessStatusCode();
await File.WriteAllBytesAsync(
"watermarked.pdf", await response.Content.ReadAsByteArrayAsync());Resposta
Em caso de sucesso, a resposta é 200 OK e traz no corpo o PDF com a
marca-d’água:
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Length: 48213A saída preserva a contagem de páginas e as dimensões da entrada: apenas a marca-d’água é adicionada. Grave o corpo diretamente em um arquivo, como fazem os exemplos acima; nada é armazenado do nosso lado.
Erros
Requisições com falha retornam um corpo application/problem+json. O erro mais
comum neste endpoint é um 400, retornado quando um parâmetro é inválido ou
quando file não é um PDF legível. O objeto errors nomeia cada campo:
{
"type": "https://www.pdfblocks.com/docs/api/v1/error/400",
"title": "One or more validation errors occurred.",
"status": 400,
"errors": {
"line_1": ["The field line_1 must be a string with a maximum length of 32."]
}
}Uma X-API-Key ausente ou inválida retorna um 401. Consulte
Erros para todos os códigos de status e o formato completo
da resposta.
Receitas
Variações comuns. Expanda uma para vê-la em todas as linguagens.
Um DRAFT vermelho e bem visível em todas as páginas
curl https://api.pdfblocks.com/v1/add_text_watermark \
-H 'X-API-Key: your_api_key' \
-F file=@input.pdf \
-F line_1='DRAFT' \
-F color=Red \
-F template=1001 \
-F transparency=40 \
-o draft.pdfimport requests
with open('input.pdf', 'rb') as file:
response = requests.post(
'https://api.pdfblocks.com/v1/add_text_watermark',
headers={'X-API-Key': 'your_api_key'},
files={'file': file},
data={'line_1': 'DRAFT', 'color': 'Red', 'template': 1001, 'transparency': 40},
)
response.raise_for_status()
with open('draft.pdf', 'wb') as output:
output.write(response.content)import { readFile, writeFile } from 'node:fs/promises';
const body = new FormData();
body.set('file', new Blob([await readFile('input.pdf')]), 'input.pdf');
body.set('line_1', 'DRAFT');
body.set('color', 'Red');
body.set('template', '1001');
body.set('transparency', '40');
const response = await fetch('https://api.pdfblocks.com/v1/add_text_watermark', {
method: 'POST',
headers: { 'X-API-Key': 'your_api_key' },
body,
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
await writeFile('draft.pdf', Buffer.from(await response.arrayBuffer()));<?php
$ch = curl_init('https://api.pdfblocks.com/v1/add_text_watermark');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['X-API-Key: your_api_key'],
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => [
'file' => new CURLFile('input.pdf', 'application/pdf'),
'line_1' => 'DRAFT',
'color' => 'Red',
'template' => '1001',
'transparency' => '40',
],
]);
$pdf = curl_exec($ch);
if (curl_getinfo($ch, CURLINFO_HTTP_CODE) === 200) {
file_put_contents('draft.pdf', $pdf);
}require 'http'
response = HTTP
.headers('X-API-Key' => 'your_api_key')
.post('https://api.pdfblocks.com/v1/add_text_watermark', form: {
file: HTTP::FormData::File.new('input.pdf'),
line_1: 'DRAFT',
color: 'Red',
template: '1001',
transparency: '40',
})
File.write('draft.pdf', response.body) if response.status.success?package main
import (
"bytes"
"io"
"mime/multipart"
"net/http"
"os"
)
func main() {
var buf bytes.Buffer
form := multipart.NewWriter(&buf)
file, _ := os.Open("input.pdf")
defer file.Close()
part, _ := form.CreateFormFile("file", "input.pdf")
io.Copy(part, file)
form.WriteField("line_1", "DRAFT")
form.WriteField("color", "Red")
form.WriteField("template", "1001")
form.WriteField("transparency", "40")
form.Close()
req, _ := http.NewRequest("POST", "https://api.pdfblocks.com/v1/add_text_watermark", &buf)
req.Header.Set("Content-Type", form.FormDataContentType())
req.Header.Set("X-API-Key", "your_api_key")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
out, _ := os.Create("draft.pdf")
defer out.Close()
io.Copy(out, res.Body)
}using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-API-Key", "your_api_key");
using var form = new MultipartFormDataContent
{
{ new ByteArrayContent(File.ReadAllBytes("input.pdf")), "file", "input.pdf" },
{ new StringContent("DRAFT"), "line_1" },
{ new StringContent("Red"), "color" },
{ new StringContent("1001"), "template" },
{ new StringContent("40"), "transparency" },
};
var response = await client.PostAsync(
"https://api.pdfblocks.com/v1/add_text_watermark", form);
response.EnsureSuccessStatusCode();
await File.WriteAllBytesAsync(
"draft.pdf", await response.Content.ReadAsByteArrayAsync());Um CONFIDENTIAL em contorno na capa
curl https://api.pdfblocks.com/v1/add_text_watermark \
-H 'X-API-Key: your_api_key' \
-F file=@input.pdf \
-F line_1='CONFIDENTIAL' \
-F template=1017 \
-F pages='1' \
-o confidential.pdfimport requests
with open('input.pdf', 'rb') as file:
response = requests.post(
'https://api.pdfblocks.com/v1/add_text_watermark',
headers={'X-API-Key': 'your_api_key'},
files={'file': file},
data={'line_1': 'CONFIDENTIAL', 'template': 1017, 'pages': '1'},
)
response.raise_for_status()
with open('confidential.pdf', 'wb') as output:
output.write(response.content)import { readFile, writeFile } from 'node:fs/promises';
const body = new FormData();
body.set('file', new Blob([await readFile('input.pdf')]), 'input.pdf');
body.set('line_1', 'CONFIDENTIAL');
body.set('template', '1017');
body.set('pages', '1');
const response = await fetch('https://api.pdfblocks.com/v1/add_text_watermark', {
method: 'POST',
headers: { 'X-API-Key': 'your_api_key' },
body,
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
await writeFile('confidential.pdf', Buffer.from(await response.arrayBuffer()));<?php
$ch = curl_init('https://api.pdfblocks.com/v1/add_text_watermark');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['X-API-Key: your_api_key'],
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => [
'file' => new CURLFile('input.pdf', 'application/pdf'),
'line_1' => 'CONFIDENTIAL',
'template' => '1017',
'pages' => '1',
],
]);
$pdf = curl_exec($ch);
if (curl_getinfo($ch, CURLINFO_HTTP_CODE) === 200) {
file_put_contents('confidential.pdf', $pdf);
}require 'http'
response = HTTP
.headers('X-API-Key' => 'your_api_key')
.post('https://api.pdfblocks.com/v1/add_text_watermark', form: {
file: HTTP::FormData::File.new('input.pdf'),
line_1: 'CONFIDENTIAL',
template: '1017',
pages: '1',
})
File.write('confidential.pdf', response.body) if response.status.success?package main
import (
"bytes"
"io"
"mime/multipart"
"net/http"
"os"
)
func main() {
var buf bytes.Buffer
form := multipart.NewWriter(&buf)
file, _ := os.Open("input.pdf")
defer file.Close()
part, _ := form.CreateFormFile("file", "input.pdf")
io.Copy(part, file)
form.WriteField("line_1", "CONFIDENTIAL")
form.WriteField("template", "1017")
form.WriteField("pages", "1")
form.Close()
req, _ := http.NewRequest("POST", "https://api.pdfblocks.com/v1/add_text_watermark", &buf)
req.Header.Set("Content-Type", form.FormDataContentType())
req.Header.Set("X-API-Key", "your_api_key")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
out, _ := os.Create("confidential.pdf")
defer out.Close()
io.Copy(out, res.Body)
}using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-API-Key", "your_api_key");
using var form = new MultipartFormDataContent
{
{ new ByteArrayContent(File.ReadAllBytes("input.pdf")), "file", "input.pdf" },
{ new StringContent("CONFIDENTIAL"), "line_1" },
{ new StringContent("1017"), "template" },
{ new StringContent("1"), "pages" },
};
var response = await client.PostAsync(
"https://api.pdfblocks.com/v1/add_text_watermark", form);
response.EnsureSuccessStatusCode();
await File.WriteAllBytesAsync(
"confidential.pdf", await response.Content.ReadAsByteArrayAsync());Um aviso cinza discreto em todas as páginas, exceto a última
curl https://api.pdfblocks.com/v1/add_text_watermark \
-H 'X-API-Key: your_api_key' \
-F file=@input.pdf \
-F line_1='ACME, Inc.' \
-F line_2='Do not distribute' \
-F color=Gray \
-F transparency=88 \
-F pages='..-2' \
-o notice.pdfimport requests
with open('input.pdf', 'rb') as file:
response = requests.post(
'https://api.pdfblocks.com/v1/add_text_watermark',
headers={'X-API-Key': 'your_api_key'},
files={'file': file},
data={
'line_1': 'ACME, Inc.',
'line_2': 'Do not distribute',
'color': 'Gray',
'transparency': 88,
'pages': '..-2',
},
)
response.raise_for_status()
with open('notice.pdf', 'wb') as output:
output.write(response.content)import { readFile, writeFile } from 'node:fs/promises';
const body = new FormData();
body.set('file', new Blob([await readFile('input.pdf')]), 'input.pdf');
body.set('line_1', 'ACME, Inc.');
body.set('line_2', 'Do not distribute');
body.set('color', 'Gray');
body.set('transparency', '88');
body.set('pages', '..-2');
const response = await fetch('https://api.pdfblocks.com/v1/add_text_watermark', {
method: 'POST',
headers: { 'X-API-Key': 'your_api_key' },
body,
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
await writeFile('notice.pdf', Buffer.from(await response.arrayBuffer()));<?php
$ch = curl_init('https://api.pdfblocks.com/v1/add_text_watermark');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['X-API-Key: your_api_key'],
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => [
'file' => new CURLFile('input.pdf', 'application/pdf'),
'line_1' => 'ACME, Inc.',
'line_2' => 'Do not distribute',
'color' => 'Gray',
'transparency' => '88',
'pages' => '..-2',
],
]);
$pdf = curl_exec($ch);
if (curl_getinfo($ch, CURLINFO_HTTP_CODE) === 200) {
file_put_contents('notice.pdf', $pdf);
}require 'http'
response = HTTP
.headers('X-API-Key' => 'your_api_key')
.post('https://api.pdfblocks.com/v1/add_text_watermark', form: {
file: HTTP::FormData::File.new('input.pdf'),
line_1: 'ACME, Inc.',
line_2: 'Do not distribute',
color: 'Gray',
transparency: '88',
pages: '..-2',
})
File.write('notice.pdf', response.body) if response.status.success?package main
import (
"bytes"
"io"
"mime/multipart"
"net/http"
"os"
)
func main() {
var buf bytes.Buffer
form := multipart.NewWriter(&buf)
file, _ := os.Open("input.pdf")
defer file.Close()
part, _ := form.CreateFormFile("file", "input.pdf")
io.Copy(part, file)
form.WriteField("line_1", "ACME, Inc.")
form.WriteField("line_2", "Do not distribute")
form.WriteField("color", "Gray")
form.WriteField("transparency", "88")
form.WriteField("pages", "..-2")
form.Close()
req, _ := http.NewRequest("POST", "https://api.pdfblocks.com/v1/add_text_watermark", &buf)
req.Header.Set("Content-Type", form.FormDataContentType())
req.Header.Set("X-API-Key", "your_api_key")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
out, _ := os.Create("notice.pdf")
defer out.Close()
io.Copy(out, res.Body)
}using var client = new HttpClient();
client.DefaultRequestHeaders.Add("X-API-Key", "your_api_key");
using var form = new MultipartFormDataContent
{
{ new ByteArrayContent(File.ReadAllBytes("input.pdf")), "file", "input.pdf" },
{ new StringContent("ACME, Inc."), "line_1" },
{ new StringContent("Do not distribute"), "line_2" },
{ new StringContent("Gray"), "color" },
{ new StringContent("88"), "transparency" },
{ new StringContent("..-2"), "pages" },
};
var response = await client.PostAsync(
"https://api.pdfblocks.com/v1/add_text_watermark", form);
response.EnsureSuccessStatusCode();
await File.WriteAllBytesAsync(
"notice.pdf", await response.Content.ReadAsByteArrayAsync());