← PDFtoSCAN Log masuk / Dapatkan kunci API

Dokumentasi API

Gunakan penukaran PDFtoSCAN dari aplikasi anda. Semua permintaan API memerlukan kunci API (dapatkan selepas pendaftaran).

URL asas

Semua endpoint relatif kepada:

https://pdftoscan.com/api/v1

Pengesahan

Sertakan kunci API anda dalam setiap permintaan menggunakan salah satu kaedah ini:

Header Header X-API-Key: kunci-api-anda
Header Header Authorization: Bearer kunci-api-anda

Untuk mendapatkan kunci API: pendaftaran, kemudian dalam Papan pemuka anda jana kunci baharu. Kunci hanya ditunjukkan sekali—simpan dengan selamat.

Tukar ke rupa diimbas

POST /convert.php

Muat naik PDF atau imej, atau hantar URL fail, dan terima PDF dengan rupa diimbas (condong, hingar, latar belakang kotor pilihan, A4 pilihan).

Permintaan

Kaedah: POST
Content-Type: multipart/form-data (atau application/x-www-form-urlencoded apabila menggunakan file_url sahaja anda boleh menggunakan application/x-www-form-urlencoded)

Parameter

Parameter	Jenis	Wajib	Keterangan
`file` atau `pdf`	file	Tidak	Fail PDF, JPG, PNG, TIFF atau WebP untuk ditukar (muat naik). Gunakan file atau file_url.
`file_url`	string	Tidak	URL HTTP(S) PDF atau imej untuk ditukar. Gunakan muat naik fail atau file_url (maks. 50 MB, masa tamat 30 s).
`color_mode`	string	Tidak	color atau bw. Lalai: bw (hitam putih).
`rotate`	number	Tidak	Kecondongan halaman dalam darjah (-1.5 hingga 1.5). Lalai: 0.
`noise`	number	Tidak	Jumlah hingar 0–1. Lalai: 0.1 (10%).
`dirty_background`	string	Tidak	1 (lalai) untuk tunjuk tepi hitam kotor, 0 untuk lumpuhkan.
`force_a4`	string	Tidak	1 (lalai) untuk sesuaikan output ke A4, 0 untuk kekalkan saiz asal.

Respons

Berjaya (200): Badan respons ialah fail PDF. Simpan atau strim kandungan perduaan.

Ralat (4xx/5xx): Badan JSON: {"ok": false, "error": "Mesej ralat"}

Kod status

Code	Maksud
200	Berjaya — respons ialah PDF.
400	Permintaan tidak sah — fail hilang, format salah atau ralat muat naik.
401	Tidak dibenarkan — kunci API hilang atau tidak sah.
405	Kaedah tidak dibenarkan — gunakan POST.
500	Ralat pelayan — penukaran gagal.
503	Perkhidmatan tidak tersedia — penukaran tidak tersedia pada pelayan.

Contoh

cURL

Muat naik fail:

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

Atau hantar URL fail:

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

Permintaan dari pelayar dibenarkan dari mana-mana asal. Permintaan OPTIONS preflight disokong.

Penggunaan dan had

Setiap penukaran dikira per kunci API. Dalam papan pemuka anda anda boleh lihat jumlah penggunaan dan penggunaan 7 dan 30 hari lepas. Tiada had kadar terbina dalam; had muat naik dan sumber pelayan mungkin terpakai.

Format disokong

Input: PDF, JPG, JPEG, PNG, TIFF, WebP.

Output: Sentiasa PDF (dengan rupa diimbas).