← PDFtoSCAN Zaloguj się / Uzyskaj klucz API

Dokumentacja API

Użyj konwersji PDFtoSCAN ze swoich aplikacji. Wszystkie żądania API wymagają klucza API (uzyskaj po rejestracji).

Podstawowy URL

Wszystkie punkty końcowe są względne do:

https://pdftoscan.com/api/v1

Uwierzytelnianie

Dołącz swój klucz API w każdym żądaniu, używając jednej z tych metod:

Header Nagłówek X-API-Key: twój-klucz-api
Header Nagłówek Authorization: Bearer twój-klucz-api

Aby uzyskać klucz API: rejestracji, następnie w swoim Panel wygeneruj nowy klucz. Klucz jest wyświetlany tylko raz—przechowuj go bezpiecznie.

Konwertuj na wygląd zeskanowany

POST /convert.php

Prześlij PDF lub obraz albo wyślij URL pliku i otrzymaj PDF z wyglądem zeskanowanym (przechylenie, szum, opcjonalne brudne tło, opcjonalne A4).

Żądanie

Metoda: POST
Content-Type: multipart/form-data (lub application/x-www-form-urlencoded używając tylko file_url możesz użyć application/x-www-form-urlencoded)

Parametry

Parametr	Typ	Wymagany	Opis
`file` lub `pdf`	file	Nie	Plik PDF, JPG, PNG, TIFF lub WebP do konwersji (przesyłanie). Użyj file lub file_url.
`file_url`	string	Nie	URL HTTP(S) pliku PDF lub obrazu do konwersji. Użyj przesyłania pliku lub file_url (maks. 50 MB, limit czasu 30 s).
`color_mode`	string	Nie	color lub bw. Domyślnie: bw (czarno-białe).
`rotate`	number	Nie	Przechylenie strony w stopniach (-1.5 do 1.5). Domyślnie: 0.
`noise`	number	Nie	Ilość szumu 0–1. Domyślnie: 0.1 (10%).
`dirty_background`	string	Nie	1 (domyślnie), aby pokazać brudne czarne krawędzie, 0, aby wyłączyć.
`force_a4`	string	Nie	1 (domyślnie), aby dopasować wyjście do A4, 0, aby zachować oryginalny rozmiar.

Odpowiedź

Sukces (200): Treść odpowiedzi to plik PDF. Zapisz lub strumieniuj zawartość binarną.

Błąd (4xx/5xx): Treść JSON: {"ok": false, "error": "Komunikat błędu"}

Kody statusu

Code	Znaczenie
200	Sukces — odpowiedź to PDF.
400	Złe żądanie — brak pliku, zły format lub błąd przesyłania.
401	Nieautoryzowany — brak lub nieprawidłowy klucz API.
405	Metoda niedozwolona — użyj POST.
500	Błąd serwera — konwersja nie powiodła się.
503	Usługa niedostępna — konwersja niedostępna na serwerze.

Przykłady

cURL

Prześlij plik:

curl -X POST "https://pdftoscan.com/api/v1/convert.php" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@/path/to/document.pdf" \
  -F "color_mode=bw" \
  -F "force_a4=1" \
  -o scanned.pdf

Lub wyślij URL pliku:

curl -X POST "https://pdftoscan.com/api/v1/convert.php" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d "file_url=https://example.com/document.pdf" \
  -d "color_mode=bw" \
  -d "force_a4=1" \
  -o scanned.pdf

JavaScript (fetch)

const formData = new FormData();
formData.append('file', fileInput.files[0]);
formData.append('color_mode', 'bw');
formData.append('force_a4', '1');

const response = await fetch('https://pdftoscan.com/api/v1/convert.php', {
  method: 'POST',
  headers: { 'X-API-Key': 'YOUR_API_KEY' },
  body: formData
});

if (!response.ok) {
  const err = await response.json();
  throw new Error(err.error || 'Request failed');
}
const blob = await response.blob();
// e.g. save or open blob as PDF

Python

import requests

url = 'https://pdftoscan.com/api/v1/convert.php'
headers = {'X-API-Key': 'YOUR_API_KEY'}
files = {'file': open('document.pdf', 'rb')}
data = {'color_mode': 'bw', 'force_a4': '1'}

r = requests.post(url, headers=headers, files=files, data=data)

if r.status_code != 200:
    print(r.json().get('error', 'Error'))
else:
    with open('scanned.pdf', 'wb') as f:
        f.write(r.content)

CORS

Żądania z przeglądarek są dozwolone z dowolnego źródła. Żądania OPTIONS preflight są obsługiwane.

Użycie i limity

Każda konwersja jest liczona na klucz API. W swoim panelu możesz zobaczyć całkowite użycie i użycie w ciągu ostatnich 7 i 30 dni. Nie ma wbudowanych limitów szybkości; mogą obowiązywać limity przesyłania i zasobów serwera.

Obsługiwane formaty

Wejście: PDF, JPG, JPEG, PNG, TIFF, WebP.

Wyjście: Zawsze PDF (z wyglądem zeskanowanym).