← PDFtoSCAN Ingia / Pata funguo ya API

Nyaraka za API

Tumia ubadilishaji wa PDFtoSCAN kutoka kwa programu zako. Maombi yote ya API yanahitaji funguo ya API (pata moja baada ya usajili).

URL ya msingi

Ncha zote ni jamaa na:

https://pdftoscan.com/api/v1

Uthibitishaji

Jumuisha funguo yako ya API katika kila ombi kwa kutumia njia moja ya hizi:

Header Kichwa X-API-Key: funguo-yako-ya-api
Header Kichwa Authorization: Bearer funguo-yako-ya-api

Kupata funguo ya API: usajili, kisha kwenye Dashibodi yako tengeneza funguo mpya. Funguo inaonyeshwa mara moja tu—ihifadhi kwa usalama.

Badilisha kuwa sura ya kuchanganwa

POST /convert.php

Pakia PDF au picha, au tuma URL ya faili, na upokee PDF yenye sura ya kuchanganwa (mweko, kelele, mandharinyuma machafu ya hiari, A4 ya hiari).

Ombi

Njia: POST
Content-Type: multipart/form-data (au application/x-www-form-urlencoded unapotumia file_url peke yake unaweza kutumia application/x-www-form-urlencoded)

Vigezo

Kigezo	Aina	Inahitajika	Maelezo
`file` au `pdf`	file	Hapana	Faili la PDF, JPG, PNG, TIFF au WebP kubadilisha (pakio). Tumia file au file_url.
`file_url`	string	Hapana	URL ya HTTP(S) ya PDF au picha kubadilisha. Tumia pakio la faili au file_url (kiwango cha juu 50 MB, muda wa 30 s).
`color_mode`	string	Hapana	color au bw. Chaguo-msingi: bw (nyeusi na nyeupe).
`rotate`	number	Hapana	Mweko wa ukurasa kwa digrii (-1.5 hadi 1.5). Chaguo-msingi: 0.
`noise`	number	Hapana	Kiasi cha kelele 0–1. Chaguo-msingi: 0.1 (10%).
`dirty_background`	string	Hapana	1 (chaguo-msingi) kuonyesha kingo meusi machafu, 0 kuzima.
`force_a4`	string	Hapana	1 (chaguo-msingi) kulinganisha pato na A4, 0 kuhifadhi ukubwa asili.

Jibu

Mafanikio (200): Mwili wa jibu ni faili la PDF. Hifadhi au stream maudhui ya binary.

Hitilafu (4xx/5xx): Mwili wa JSON: {"ok": false, "error": "Ujumbe wa hitilafu"}

Msimbo wa hali

Code	Maana
200	Mafanikio — jibu ni PDF.
400	Ombi batili — faili inayokosekana, umbizo lisilo sahihi au hitilafu ya pakio.
401	Haijaruhusiwa — funguo ya API inayokosekana au batili.
405	Njia hairuhusiwi — tumia POST.
500	Hitilafu ya seva — ubadilishaji umeshindwa.
503	Huduma haipatikani — ubadilishaji haupatikani kwenye seva.

Mifano

cURL

Pakia faili:

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

Au tuma URL ya faili:

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

Maombi kutoka kivinjari yanaruhusiwa kutoka asili yoyote. Maombi ya OPTIONS ya preflight yanasaidiwa.

Matumizi na mipaka

Kila ubadilishaji unalinganiwa kwa funguo ya API. Kwenye dashibodi yako unaweza kuona matumizi jumla na matumizi za siku 7 na 30 zilizopita. Hakuna mipaka ya kiwango iliyojengwa; mipaka ya pakio na rasilimali ya seva inaweza kutumika.

Miundo inayosaidiwa

Ingizo: PDF, JPG, JPEG, PNG, TIFF, WebP.

Pato: PDF kila wakati (yenye sura ya kuchanganwa).