Início rápido
Três passos para sua primeira chamada à API.
- Crie uma chave de API em Conta › Chaves de API
- Envie um POST multipart/form-data para um dos endpoints v1 com cabeçalho Authorization: Bearer.
- Inspecione a resposta JSON — chamadas bem-sucedidas retornam uma URL assinada de download válida por 15 minutos.
URL base
Autenticação
Toda requisição deve incluir um cabeçalho Authorization com sua chave de API como token Bearer.
Authorization: Bearer pdn_live_a1b2c3d4e5f6...Formatos de chave
pdn_live_<32 hex>— Chave de produção. Conta para o limite do seu plano.pdn_test_<32 hex>— Chave de teste. Mesmo limite; útil para distinguir ambientes nos logs.
Limites de requisição
Os limites são calculados por usuário, em uma janela móvel de 1 hora. Toda resposta inclui cabeçalhos X-RateLimit-* para que você planeje suas tentativas.
| Plano | Requisições / hora |
|---|---|
| Free | 10 |
| Premium | 1,000 |
| Business | 5,000 |
| Enterprise | Ilimitado |
Cabeçalhos de resposta
X-RateLimit-Limit— O teto horário do seu plano.X-RateLimit-Remaining— Chamadas restantes na janela atual.X-RateLimit-Reset— Timestamp Unix de quando a janela reinicia.Retry-After— Segundos para esperar, enviado apenas em respostas 429.
Erros
Todos os erros são retornados como JSON com um código estável e uma mensagem legível.
{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded for your plan (free: 10/hour)."
},
"meta": { "request_id": "8f9a2b3c1d4e5f6a" }
}Códigos de erro
| Code | HTTP | Significado |
|---|---|---|
unauthorized | 401 | Chave de API ausente, inválida ou revogada. |
rate_limited | 429 | Limite horário excedido para o seu plano. |
invalid_input | 400 | Corpo ou parâmetros da requisição falharam na validação. |
payload_too_large | 413 | Arquivo ou payload combinado excede o limite de tamanho do seu plano. |
internal_error | 500 | Erro inesperado do servidor. Seguro tentar novamente com backoff. |
POST /compress
Comprime um PDF usando Ghostscript quando disponível, com fallback FPDI. Retorna uma URL assinada de download.
Parâmetros (multipart/form-data)
| Nome | Tipo | Descrição |
|---|---|---|
| file * | file | Arquivo PDF para comprimir. |
| level | string | Predefinição de compressão. low, medium, high |
Exemplos de código
curl -X POST https://whatapdf.com/api/v1/compress \
-H "Authorization: Bearer pdn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-F "[email protected]" \
-F "level=medium"const form = new FormData();
form.append('file', fileInput.files[0]);
form.append('level', 'medium');
const res = await fetch('https://whatapdf.com/api/v1/compress', {
method: 'POST',
headers: { 'Authorization': 'Bearer pdn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' },
body: form,
});
const json = await res.json();
console.log(json.data.download.url);import requests
with open('input.pdf', 'rb') as f:
r = requests.post(
'https://whatapdf.com/api/v1/compress',
headers={'Authorization': 'Bearer pdn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'},
files={'file': f},
data={'level': 'medium'},
)
print(r.json())<?php
$ch = curl_init('https://whatapdf.com/api/v1/compress');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer pdn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'],
CURLOPT_POSTFIELDS => [
'file' => new CURLFile('input.pdf', 'application/pdf'),
'level' => 'medium',
],
]);
$res = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($res);Resposta de exemplo
{
"data": {
"filename": "report_compressed.pdf",
"original_size": 5242880,
"compressed_size": 2621440,
"savings_percent": 50.0,
"method": "ghostscript",
"download": {
"url": "/api/get-pdf.php?file=...&exp=...&sig=...",
"expires_in": 900
}
},
"meta": { "request_id": "8f9a2b3c1d4e5f6a" }
}POST /merge
Une de 2 a 20 PDFs em um único documento na ordem de upload.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| files[] * | file[] | Dois ou mais arquivos PDF (array multipart). |
Exemplos de código
curl -X POST https://whatapdf.com/api/v1/merge \
-H "Authorization: Bearer pdn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-F "files[][email protected]" \
-F "files[][email protected]" \
-F "files[][email protected]"const form = new FormData();
for (const f of fileInput.files) form.append('files[]', f);
const res = await fetch('https://whatapdf.com/api/v1/merge', {
method: 'POST',
headers: { 'Authorization': 'Bearer pdn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' },
body: form,
});
console.log(await res.json());import requests
files = [
('files[]', open('a.pdf', 'rb')),
('files[]', open('b.pdf', 'rb')),
('files[]', open('c.pdf', 'rb')),
]
r = requests.post(
'https://whatapdf.com/api/v1/merge',
headers={'Authorization': 'Bearer pdn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'},
files=files,
)
print(r.json())<?php
$ch = curl_init('https://whatapdf.com/api/v1/merge');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer pdn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'],
CURLOPT_POSTFIELDS => [
'files[0]' => new CURLFile('a.pdf', 'application/pdf'),
'files[1]' => new CURLFile('b.pdf', 'application/pdf'),
'files[2]' => new CURLFile('c.pdf', 'application/pdf'),
],
]);
echo curl_exec($ch);
curl_close($ch);POST /split
Divide um PDF em uma ou mais partes por intervalos de páginas. Cada parte é retornada com sua própria URL assinada de download.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| file * | file | PDF de origem. |
| ranges * | string | Intervalos de páginas separados por vírgula. Um intervalo = uma parte de saída. e.g. 1-3,5,7-9 |
Exemplos de código
curl -X POST https://whatapdf.com/api/v1/split \
-H "Authorization: Bearer pdn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-F "[email protected]" \
-F "ranges=1-3,5,7-9"const form = new FormData();
form.append('file', fileInput.files[0]);
form.append('ranges', '1-3,5,7-9');
const res = await fetch('https://whatapdf.com/api/v1/split', {
method: 'POST',
headers: { 'Authorization': 'Bearer pdn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' },
body: form,
});
console.log(await res.json());import requests
with open('input.pdf', 'rb') as f:
r = requests.post(
'https://whatapdf.com/api/v1/split',
headers={'Authorization': 'Bearer pdn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'},
files={'file': f},
data={'ranges': '1-3,5,7-9'},
)
for part in r.json()['data']['parts']:
print(part['pages'], part['download']['url'])<?php
$ch = curl_init('https://whatapdf.com/api/v1/split');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer pdn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'],
CURLOPT_POSTFIELDS => [
'file' => new CURLFile('input.pdf', 'application/pdf'),
'ranges' => '1-3,5,7-9',
],
]);
print_r(json_decode(curl_exec($ch), true));
curl_close($ch);POST /ocr
Extrai texto de uma imagem usando Tesseract OCR. Suporta mais de 20 idiomas.
Parâmetros
| Nome | Tipo | Descrição |
|---|---|---|
| image * | file | Imagem para OCR (PNG, JPEG, TIFF, WebP ou BMP). |
| language | string | Código de idioma do Tesseract. Padrão eng |
Exemplos de código
curl -X POST https://whatapdf.com/api/v1/ocr \
-H "Authorization: Bearer pdn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-F "[email protected]" \
-F "language=eng"const form = new FormData();
form.append('image', imageInput.files[0]);
form.append('language', 'eng');
const res = await fetch('https://whatapdf.com/api/v1/ocr', {
method: 'POST',
headers: { 'Authorization': 'Bearer pdn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx' },
body: form,
});
const { data } = await res.json();
console.log(data.text);import requests
with open('scan.png', 'rb') as f:
r = requests.post(
'https://whatapdf.com/api/v1/ocr',
headers={'Authorization': 'Bearer pdn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'},
files={'image': f},
data={'language': 'eng'},
)
print(r.json()['data']['text'])<?php
$ch = curl_init('https://whatapdf.com/api/v1/ocr');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => ['Authorization: Bearer pdn_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'],
CURLOPT_POSTFIELDS => [
'image' => new CURLFile('scan.png', 'image/png'),
'language' => 'eng',
],
]);
$res = json_decode(curl_exec($ch), true);
echo $res['data']['text'];
curl_close($ch);