← PDFtoSCAN Logi sisse / Hangi API võti

API Dokumentatsioon

Kasutage PDFtoSCAN teisendamist oma rakendustest. Kõik API päringud nõuavad API võtit (hankige pärast registreerimist).

Baas-URL

Kõik lõpp-punktid on suhtelised:

https://pdftoscan.com/api/v1

Autentimine

Lisage oma API võti igasse päringussse, kasutades ühte neist meetoditest:

Header Päis X-API-Key: teie-api-võti
Header Päis Authorization: Bearer teie-api-võti

API võtme hankimiseks: registreerimist, seejärel oma Juhtpaneel-s genereerige uus võti. Võtit kuvatakse ainult üks kord—hoidke seda turvaliselt.

Teisenda skannitud välimuseks

POST /convert.php

Laadige üles PDF või pilt või saatke faili URL ja saage PDF skannitud välimusega (kalded, müra, valikuline määrdunud taust, valikuline A4).

Päring

Meetod: POST
Content-Type: multipart/form-data (või application/x-www-form-urlencoded kui kasutate ainult file_url, saate kasutada application/x-www-form-urlencoded)

Parameetrid

Parameeter	Tüüp	Nõutav	Kirjeldus
`file` või `pdf`	file	Ei	PDF, JPG, PNG, TIFF või WebP fail teisendamiseks (üleslaadimine). Kasutage file või file_url.
`file_url`	string	Ei	HTTP(S) URL PDF või pildi teisendamiseks. Kasutage faili üleslaadimist või file_url (maks. 50 MB, 30 s ajalõpp).
`color_mode`	string	Ei	color või bw. Vaikimisi: bw (must-valge).
`rotate`	number	Ei	Lehe kalded kraadides (-1.5 kuni 1.5). Vaikimisi: 0.
`noise`	number	Ei	Müra kogus 0–1. Vaikimisi: 0.1 (10%).
`dirty_background`	string	Ei	1 (vaikimisi) määrdunud mustade servade kuvamiseks, 0 keelamiseks.
`force_a4`	string	Ei	1 (vaikimisi) väljundi A4-le kohandamiseks, 0 algse suuruse säilitamiseks.

Vastus

Edukas (200): Vastuse sisu on PDF fail. Salvestage või voogedastage binaarne sisu.

Viga (4xx/5xx): JSON sisu: {"ok": false, "error": "Veateade"}

Olekukoodid

Code	Tähendus
200	Edukas — vastus on PDF.
400	Halb päring — fail puudub, vale vorming või üleslaadimise viga.
401	Volitamata — API võti puudub või on kehtetu.
405	Meetod pole lubatud — kasutage POST.
500	Serveri viga — teisendamine ebaõnnestus.
503	Teenus pole saadaval — teisendamine pole serveris saadaval.

Näited

cURL

Laadige üles 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

Või saatke faili URL:

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

Brauserite päringud on lubatud mis tahes päritolust. Preflight OPTIONS päringud on toetatud.

Kasutamine ja piirangud

Iga teisendus loetakse API võtme kohta. Oma juhtpaneelil saate vaadata kogu kasutamist ja kasutamist viimase 7 ja 30 päeva jooksul. Sisseehitatud kiiruspiiranguid pole; võivad kehtida serveri üleslaadimise ja ressursside piirangud.

Toetatud vormingud

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

Väljund: Alati PDF (skannitud välimusega).