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 (स्कॅन केलेल्या दिसण्यासह).