← PDFtoSCAN Kirjaudu / Hanki API-avain

API-dokumentaatio

Käytä PDFtoSCAN-muunnosta sovelluksistasi. Kaikki API-pyynnöt vaativat API-avaimen (hanki rekisteröitymisen jälkeen).

Perus-URL

Kaikki päätepisteet ovat suhteessa:

https://pdftoscan.com/api/v1

Todennus

Sisällytä API-avaimesi jokaiseen pyyntöön käyttämällä jotakin näistä menetelmistä:

Header Otsikko X-API-Key: api-avaimesi
Header Otsikko Authorization: Bearer api-avaimesi

API-avaimen hankkimiseksi: rekisteröitymisen, luo sitten uusi avain Kojelauta:ssasi. Avain näytetään vain kerran—säilytä se turvallisesti.

Muunna skannatuksi ulkonäöksi

POST /convert.php

Lataa PDF tai kuva tai lähetä tiedoston URL ja vastaanota PDF, joka näyttää skannatulta (kallistus, kohina, valinnainen likainen tausta, valinnainen A4).

Pyyntö

Menetelmä: POST
Content-Type: multipart/form-data (tai application/x-www-form-urlencoded kun käytät vain file_url:ää voit käyttää application/x-www-form-urlencoded)

Parametrit

Parametri	Tyyppi	Vaaditaan	Kuvaus
`file` tai `pdf`	file	Ei	PDF-, JPG-, PNG-, TIFF- tai WebP-tiedosto muunnettavaksi (lataus). Käytä file tai file_url.
`file_url`	string	Ei	HTTP(S) URL PDF:lle tai kuvalle muunnettavaksi. Käytä tiedoston latausta tai file_url (enintään 50 MB, 30 s aikakatkaisu).
`color_mode`	string	Ei	color tai bw. Oletus: bw (mustavalkoinen).
`rotate`	number	Ei	Sivun kallistus asteina (-1.5 - 1.5). Oletus: 0.
`noise`	number	Ei	Kohinan määrä 0–1. Oletus: 0.1 (10%).
`dirty_background`	string	Ei	1 (oletus) likaisten mustien reunojen näyttämiseksi, 0 poistaaksesi käytöstä.
`force_a4`	string	Ei	1 (oletus) tulosteen sovittamiseksi A4:ään, 0 alkuperäisen koon säilyttämiseksi.

Vastaus

Onnistui (200): Vastauksen runko on PDF-tiedosto. Tallenna tai suoratoista binäärisisältö.

Virhe (4xx/5xx): JSON-runko: {"ok": false, "error": "Virheilmoitus"}

Tilakoodit

Code	Merkitys
200	Onnistui — vastaus on PDF.
400	Virheellinen pyyntö — tiedosto puuttuu, väärä muoto tai latausvirhe.
401	Ei valtuutettu — API-avain puuttuu tai virheellinen.
405	Menetelmä ei sallittu — käytä POST.
500	Palvelinvirhe — muunnos epäonnistui.
503	Palvelu ei käytettävissä — muunnos ei käytettävissä palvelimella.

Esimerkit

cURL

Lataa tiedosto:

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

Tai lähetä tiedoston 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

Selainpyynnöt sallitaan mistä tahansa alkuperästä. Preflight OPTIONS -pyynnöt tuetaan.

Käyttö ja rajoitukset

Jokainen muunnos lasketaan API-avainta kohden. Kojelaudassasi voit nähdä kokonaiskäytön ja käytön viimeisten 7 ja 30 päivän ajalta. Sisäänrakennettuja nopeusrajoituksia ei ole; palvelimen lataus- ja resurssirajat voivat päteä.

Tuetut muodot

Syöte: PDF, JPG, JPEG, PNG, TIFF, WebP.

Tuloste: Aina PDF (skannatulla ulkonäöllä).