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 (સ્કેન કરેલા દેખાવ સાથે).