← PDFtoSCAN Prisijungti / Gauti API raktą

API Dokumentacija

Naudokite PDFtoSCAN konvertavimą iš savo programų. Visi API užklausos reikalauja API rakto (gaukite po registracijos).

Pagrindinis URL

Visi galutiniai taškai yra santykiniai:

https://pdftoscan.com/api/v1

Autentifikacija

Įtraukite savo API raktą į kiekvieną užklausą naudodami vieną iš šių metodų:

Header Antraštė X-API-Key: jūsų-api-raktas
Header Antraštė Authorization: Bearer jūsų-api-raktas

Norėdami gauti API raktą: registracijos, tada savo Valdymo skydelis sugeneruokite naują raktą. Raktas rodomas tik vieną kartą—saugokite jį saugiai.

Konvertuoti į nuskaitytą išvaizdą

POST /convert.php

Įkelkite PDF arba vaizdą arba atsiųskite failo URL ir gaukite PDF su nuskaitytu išvaizda (pasvirimas, triukšmas, pasirinktinis purvinas fonas, pasirinktinis A4).

Užklausa

Metodas: POST
Content-Type: multipart/form-data (arba application/x-www-form-urlencoded kai naudojate tik file_url galite naudoti application/x-www-form-urlencoded)

Parametrai

Parametras	Tipas	Privaloma	Aprašymas
`file` arba `pdf`	file	Ne	PDF, JPG, PNG, TIFF arba WebP failas konvertuoti (įkėlimas). Naudokite file arba file_url.
`file_url`	string	Ne	HTTP(S) URL PDF arba vaizdo konvertuoti. Naudokite failo įkėlimą arba file_url (maks. 50 MB, 30 s skirtasis laikas).
`color_mode`	string	Ne	color arba bw. Numatytasis: bw (juoda-balta).
`rotate`	number	Ne	Puslapio pasvirimas laipsniais (-1.5 iki 1.5). Numatytasis: 0.
`noise`	number	Ne	Triukšmo kiekis 0–1. Numatytasis: 0.1 (10%).
`dirty_background`	string	Ne	1 (numatytasis) rodyti purvinus juodus kraštus, 0 išjungti.
`force_a4`	string	Ne	1 (numatytasis) pritaikyti išvestį prie A4, 0 išlaikyti originalų dydį.

Atsakymas

Sėkmė (200): Atsakymo turinys yra PDF failas. Išsaugokite arba transliuokite dvejetainį turinį.

Klaida (4xx/5xx): JSON turinys: {"ok": false, "error": "Klaidos pranešimas"}

Būsenos kodai

Code	Reikšmė
200	Sėkmė — atsakymas yra PDF.
400	Bloga užklausa — trūksta failo, neteisingas formatas arba įkėlimo klaida.
401	Neautorizuotas — trūksta arba neteisingas API raktas.
405	Metodas neleidžiamas — naudokite POST.
500	Serverio klaida — konvertavimas nepavyko.
503	Paslauga nepasiekiama — konvertavimas nepasiekiamas serveryje.

Pavyzdžiai

cURL

Įkelti 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

Arba atsiųsti failo 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

Užklausos iš naršyklių leidžiamos iš bet kokios kilmės. Palaikomos preflight OPTIONS užklausos.

Naudojimas ir apribojimai

Kiekvienas konvertavimas skaičiuojamas pagal API raktą. Savo valdymo skydelyje galite matyti bendrą naudojimą ir naudojimą per paskutines 7 ir 30 dienų. Nėra įtaisytų greičio apribojimų; gali būti taikomi serverio įkėlimo ir išteklių apribojimai.

Palaikomi formatai

Įvestis: PDF, JPG, JPEG, PNG, TIFF, WebP.

Išvestis: Visada PDF (su nuskaitytu išvaizda).