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	లేదు	మార్చడానికి PDF లేదా చిత్రం యొక్క HTTP(S) URL. ఫైల్ అప్‌లోడ్ లేదా file_url ఉపయోగించండి (గరిష్టంగా 50 MB, 30 s టైమ్‌అవుట్).
`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

బ్రౌజర్‌ల నుండి అభ్యర్థనలు ఏ మూలం నుండి అనుమతించబడతాయి. Preflight OPTIONS అభ్యర్థనలు మద్దతు ఉన్నాయి.

వినియోగం మరియు పరిమితులు

ప్రతి మార్పిడి API కీకి లెక్కించబడుతుంది. మీ డాష్‌బోర్డ్‌లో మీరు మొత్తం వినియోగం మరియు చివరి 7 మరియు 30 రోజుల వినియోగాన్ని చూడవచ్చు. అంతర్నిర్మిత రేటు పరిమితులు లేవు; సర్వర్ అప్‌లోడ్ మరియు వనరుల పరిమితులు వర్తించవచ్చు.

మద్దతు ఉన్న ఫార్మాట్‌లు

ఇన్‌పుట్: PDF, JPG, JPEG, PNG, TIFF, WebP.

అవుట్‌పుట్: ఎల్లప్పుడూ PDF (స్కాన్ చేసిన రూపంతో).