Szybki start
Trzy kroki do pierwszego wywołania API.
- Utwórz klucz API w Konto › Klucze API
- Wyślij żądanie POST multipart/form-data do jednego z endpointów v1 z nagłówkiem Authorization: Bearer.
- Sprawdź odpowiedź JSON — pomyślne wywołania zwracają podpisany URL pobierania ważny przez 15 minut.
URL bazowy
https://whatapdf.com/api/v1
Uwierzytelnianie
Każde żądanie musi zawierać nagłówek Authorization z kluczem API jako tokenem Bearer.
Authorization: Bearer pdn_live_a1b2c3d4e5f6...Trzymaj klucze produkcyjne w tajemnicy. Traktuj je jak hasła. Nigdy nie umieszczaj ich w repozytorium ani w kodzie po stronie klienta.
Formaty kluczy
pdn_live_<32 hex>— Klucz produkcyjny. Wlicza się do limitu szybkości Twojego planu.pdn_test_<32 hex>— Klucz testowy. Ten sam limit; pomocny do rozróżniania środowisk w logach.
Limity szybkości
Limity są obliczane dla każdego użytkownika w ruchomym oknie 1-godzinnym. Każda odpowiedź zawiera nagłówki X-RateLimit-*, dzięki czemu możesz planować ponowne próby.
| Plan | Żądania / godzinę |
|---|---|
| Free | 10 |
| Premium | 1,000 |
| Business | 5,000 |
| Enterprise | Bez limitu |
Nagłówki odpowiedzi
X-RateLimit-Limit— Godzinowy limit Twojego planu.X-RateLimit-Remaining— Pozostałe wywołania w bieżącym oknie.X-RateLimit-Reset— Znacznik czasu Unix, kiedy okno się resetuje.Retry-After— Sekundy oczekiwania, wysyłane tylko w odpowiedziach 429.
Błędy
Wszystkie błędy są zwracane jako JSON ze stabilnym kodem i czytelną wiadomością.
{
"error": {
"code": "rate_limited",
"message": "Rate limit exceeded for your plan (free: 10/hour)."
},
"meta": { "request_id": "8f9a2b3c1d4e5f6a" }
}Kody błędów
| Code | HTTP | Znaczenie |
|---|---|---|
unauthorized | 401 | Brak, niepoprawny lub unieważniony klucz API. |
rate_limited | 429 | Przekroczono godzinowy limit dla Twojego planu. |
invalid_input | 400 | Treść lub parametry żądania nie przeszły walidacji. |
payload_too_large | 413 | Plik lub łączny payload przekracza limit rozmiaru Twojego planu. |
internal_error | 500 | Nieoczekiwany błąd serwera. Można bezpiecznie ponowić z backoffem. |
POST /compress
Kompresuje PDF przy użyciu Ghostscript, gdy dostępny, z fallbackiem FPDI. Zwraca podpisany URL pobierania.
POSThttps://whatapdf.com/api/v1/compress
Parametry (multipart/form-data)
| Nazwa | Typ | Opis |
|---|---|---|
| file * | file | Plik PDF do kompresji. |
| level | string | Profil kompresji. low, medium, high |
Przykłady kodu
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);Przykładowa odpowiedź
{
"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
Łączy 2–20 plików PDF w jeden dokument w kolejności przesyłania.
POSThttps://whatapdf.com/api/v1/merge
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
| files[] * | file[] | Dwa lub więcej plików PDF (tablica multipart). |
Przykłady kodu
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
Dzieli plik PDF na jedną lub więcej części według zakresów stron. Każda część otrzymuje własny podpisany URL pobierania.
POSThttps://whatapdf.com/api/v1/split
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
| file * | file | Źródłowy PDF. |
| ranges * | string | Zakresy stron oddzielone przecinkami. Jeden zakres = jedna część wyjściowa. e.g. 1-3,5,7-9 |
Przykłady kodu
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
Wyodrębnia tekst z obrazu za pomocą Tesseract OCR. Obsługuje ponad 20 języków.
POSThttps://whatapdf.com/api/v1/ocr
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
| image * | file | Obraz do OCR (PNG, JPEG, TIFF, WebP lub BMP). |
| language | string | Kod języka Tesseract. Domyślnie eng |
Przykłady kodu
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);