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

ब्राउज़र से किसी भी ओरिजिन की रिक्वेस्ट की अनुमति है। OPTIONS प्रीफ़्लाइट सपोर्टेड।

उपयोग और लिमिट

हर कन्वर्जन API कुंजी के हिसाब से काउंट होती है। डैशबोर्ड में कुल और पिछले 7 व 30 दिन का उपयोग दिखता है। कोई अंतर्निहित दर सीमा नहीं; सर्वर अपलोड और संसाधन सीमाएं लागू होती हैं।

सपोर्टेड फॉर्मैट

इनपुट: PDF, JPG, JPEG, PNG, TIFF, WebP।

आउटपुट: हमेशा PDF (स्कैन लुक)।