← PDFtoSCAN Увайсці / Атрымаць ключ API

Дакументацыя API

Выкарыстоўвайце канвертацыю PDFtoSCAN з вашых праграм. Усе запыты API патрабуюць ключ API (атрымайце пасля рэгістрацыі).

Базавы URL

Усе канцавыя кропкі адносныя да:

https://pdftoscan.com/api/v1

Аўтэнтыфікацыя

Уключыце свой ключ API ў кожны запыт, выкарыстоўваючы адзін з гэтых метадаў:

Header Загаловак X-API-Key: ваш-ключ-api
Header Загаловак Authorization: Bearer ваш-ключ-api

Каб атрымаць ключ API: рэгістрацыі, затым у сваёй Панэль кіравання згенеруйце новы ключ. Ключ паказваецца толькі адзін раз—захоўвайце яго бяспечна.

Канвертаваць у адсканаваны выгляд

POST /convert.php

Загрузіце PDF або выяву, або адпраўце URL файла, і атрымайце PDF з выглядам адсканаванага (нахіл, шум, апцыянальны брудны фон, апцыянальны A4).

Запыт

Метад: POST
Content-Type: multipart/form-data (або application/x-www-form-urlencoded пры выкарыстанні толькі file_url вы можаце выкарыстоўваць application/x-www-form-urlencoded)

Параметры

Параметр	Тып	Абавязковы	Апісанне
`file` або `pdf`	file	Не	Файл PDF, JPG, PNG, TIFF або WebP для канвертацыі (загрузка). Выкарыстоўвайце file або file_url.
`file_url`	string	Не	HTTP(S) URL PDF або выявы для канвертацыі. Выкарыстоўвайце загрузку файла або file_url (макс. 50 МБ, 30 с таймаўт).
`color_mode`	string	Не	color або bw. Па змаўчанні: bw (чорна-белы).
`rotate`	number	Не	Нахіл старонкі ў градусах (-1.5 да 1.5). Па змаўчанні: 0.
`noise`	number	Не	Колькасць шуму 0–1. Па змаўчанні: 0.1 (10%).
`dirty_background`	string	Не	1 (па змаўчанні) для паказу брудных чорных краёў, 0 для адключэння.
`force_a4`	string	Не	1 (па змаўчанні) для падгону вываду да A4, 0 для захавання арыгінальнага памеру.

Адказ

Поспех (200): Цела адказу - файл PDF. Захавайце або перадавайце бінарны змест.

Памылка (4xx/5xx): JSON цела: {"ok": false, "error": "Паведамленне пра памылку"}

Коды стану

Code	Значэнне
200	Поспех — адказ гэта PDF.
400	Дрэнны запыт — адсутнічае файл, няправільны фармат або памылка загрузкі.
401	Неаўтарызаваны — адсутнічае або несапраўдны ключ API.
405	Метад не дазволены — выкарыстоўвайце POST.
500	Памылка сервера — канвертацыя не ўдалася.
503	Сэрвіс недаступны — канвертацыя недаступная на серверы.

Прыклады

cURL

Загрузіць файл:

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

Або адправіць 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

Запыты з браўзераў дазволены з любога крыніцы. Падтрымліваюцца запыты OPTIONS preflight.

Выкарыстанне і абмежаванні

Кожная канвертацыя лічыцца на ключ API. У сваёй панэлі кіравання вы можаце бачыць агульнае выкарыстанне і выкарыстанне за апошнія 7 і 30 дзён. Няма ўбудаваных абмежаванняў хуткасці; могуць прымяняцца абмежаванні загрузкі і рэсурсаў сервера.

Падтрымліваюцца фарматы

Увод: PDF, JPG, JPEG, PNG, TIFF, WebP.

Вывад: Заўсёды PDF (з выглядам адсканаванага).