← 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	לא	URL HTTP(S) של PDF או תמונה להמרה. השתמש בהעלאת קובץ או file_url (מקס. 50 MB, פסק זמן 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 (עם מראה סרוק).