PDFLean
API Referansı

İş Akışı API

Aksi belirtilmedikçe tüm uç noktalar, oturum açmış bir oturum (çerez) gerektirir. Yanıtlar JSON biçimindedir: { ok: true, data } veya { ok: false, error }. Sık karşılaşılan hatalar: 400 doğrulama, 401 kimlik doğrulanmamış, 403 yasak, 404 bulunamadı, 429 hız sınırı, 502/503 yukarı akış. Genel /api/v1 uç noktaları Authorization: Bearer pdflean_… ile kimlik doğrulaması yapar ve JSON içerik türü göndermelidir.

Bu sayfada

İş Akışları

MetotYolAçıklama
GET/api/workflowsİş akışlarınızı listeleyin
POST/api/workflowsİş akışı oluşturun (taslak)
GET/api/workflows/:idİş akışını alın
PUT/api/workflows/:idBir iş akışını güncelleyin (taslak, sürüm+1)
DELETE/api/workflows/:idBir iş akışını silin
POST/api/workflows/:id/publishBir sürümü yayımlayın
GET/api/workflows/:id/versionsSürümleri listele
POST/api/workflows/:id/versions/:version/restoreBir sürümü geri yükleyin

Tetikleyiciler & Kancalar

MetotYolAçıklama
GET/api/workflows/triggersTetikleyicileri listele
POST/api/workflows/triggersBir tetikleyici oluştur (web kancası/zamanlama/e-posta/sürücü)
POST/api/workflows/triggers/:id/runŞimdi bir tetikleyiciyi çalıştırın
DELETE/api/workflows/triggers/:idBir tetikleyiciyi silin
POST/api/workflows/hook/:tokenGelen webhook (belirteç kimlik doğrulaması, oturum yok; JSON gövdesi)

Çalıştırmalar & İncelemeler

MetotYolAçıklama
POST/api/workflows/runsBir çalıştırma oluşturun (kuyrukta)
GET/api/workflows/runsÇalıştırmaları listele
GET/api/workflows/runs/:idÇalıştırma ayrıntıları ve adımları
POST/api/workflows/runs/:id/retryBaşarısız/kuyruktaki bir çalıştırmayı yeniden deneyin
GET/api/workflows/reviewsBekleyen insan incelemeleri
POST/api/workflows/reviews/:idBir incelemeyi onayla/reddet

Bulut Köprüsü

MetotYolAçıklama
GET/api/workflows/cloud/statusBağımsız VPS köprü durumu
POST/api/workflows/cloud/convertOffice → PDF yerel VPS (LibreOffice) üzerinden
POST/api/workflows/cloud/ocrBağımsız VPS üzerinden OCR (Tesseract)
POST/api/workflows/cloud/extractPDF'den fatura/genel alanları çıkarın (pdfjs + kurallar)

Arşiv ve Saklama

MetotYolAçıklama
GET/api/workflows/archiveArşivlenen belgeleri ve zincir bütünlüğünü listeleyin
POST/api/workflows/archiveBir belgeyi arşivleyin (base64, SHA-256 karma zinciri)
GET/api/workflows/archive/:id/verifyArşiv karma zincirini doğrulayın
GET/api/workflows/archive/exportArşiv denetim CSV'sini dışa aktarın (tombstone kayıtları dahil)
POST/api/workflows/archive/:id/holdYasal bekletmeyi ayarlayın/kaldırın
POST/api/workflows/archive/:id/complianceGeri alınamaz WORM uyumluluk kilidini etkinleştirin
DELETE/api/workflows/archive/:idBir arşivi silin (yasal bekletme altında engellenir)

Genel API v1

MetotYolAçıklama
GET/api/v1/openapi.jsonOpenAPI 3.1 spec (public, no auth)
GET/api/v1/meMevcut API anahtarı sahibi (Bearer anahtar)
GET/api/v1/usageKullanım paneli: bakiye, 30 günlük geçmiş, son çağrılar
GET/api/v1/workflowsİş akışlarını listele (kapsam workflow.read)
GET/api/v1/workflows/:idBir iş akışını getir (kapsam workflow.read)
POST/api/v1/workflows/:id/runBir çalıştırmayı kuyruğa al (kapsam workflow.run)
GET/api/v1/runsÇalıştırmaları listele (kapsam workflow.read)
POST/api/v1/pdf/mergePDF'leri birleştir (kapsam pdf.merge; 2–10 base64 dosya)
POST/api/v1/pdf/splitSeçili sayfaları sakla (kapsam pdf.split; "1-3,5" gibi aralıklar)
POST/api/v1/pdf/compressBir PDF'i yapısal olarak sıkıştır (kapsam pdf.compress)
GET/api/v1/jobs/:idİş durumu (ücretsiz)
GET/api/v1/jobs/:id/downloadBir iş sonucunu indir (ücretsiz)
POST/api/v1/convert/officeOffice/ODF belgelerini dönüştür (kapsam pdf.convert)
POST/api/v1/convert/linearizeHızlı web görüntüleme için bir PDF'i doğrusallaştır (kapsam pdf.convert)
POST/api/v1/convert/typstTypst/Markdown kaynağını PDF'e derle (kapsam pdf.convert)
POST/api/v1/ocrTaranmış bir PDF'i aranabilir PDF'e OCR yap (kapsam pdf.ocr)
POST/api/v1/ocr/textTek bir görseli metne OCR yap (kapsam pdf.ocr)
POST/api/v1/validate/pdfaPDF/A uyumluluk kontrolü (kapsam pdf.validate)
POST/api/v1/validate/pdfuaPDF/UA erişilebilirlik kontrolü (kapsam pdf.validate)
POST/api/v1/validate/signatureDijital imza doğrulama raporu (kapsam pdf.validate)
POST/api/v1/signPAdES dijital imzası (kapsam pdf.sign; isteğe bağlı PEM anahtar çifti)
POST/api/v1/redactMetin eşleşmelerinin veya alanların gerçek sansürlenmesi (kapsam pdf.redact)
POST/api/v1/extractMetin ve kural tabanlı alan çıkarma (kapsam pdf.extract)
POST/api/v1/doclingDocling ile yapılandırılmış düzen ayrıştırma (kapsam pdf.extract)
POST/api/v1/scan/piiMetni kişisel bilgiler için tara (kapsam pii.detect)

Credit consumption

Member credits refresh each billing cycle (no rollover) and are spent before purchased credits. Credits are $0.001 each.

Top up API credits in your account (from $5, never expires)

MethodEndpointCredits
GET/jobs/:id0 per call
GET/jobs/:id/download0 per call
GET/me0 per call
GET/runs0 per call
GET/usage0 per call
GET/workflows0 per call
GET/workflows/:id0 per call
POST/ai/chat3 per call
POST/ai/extract5 per call
POST/ai/pii-detect4 per call
POST/ai/summarize3 per call
POST/ai/translate3 per call
POST/convert/linearize1 per call
POST/convert/office2 per call
POST/convert/typst1 per call
POST/docling3 per call
POST/extract2 per call
POST/ocr3 per page
POST/ocr/text1 per call
POST/pdf/compress1 per call
POST/pdf/merge1 per call
POST/pdf/split1 per call
POST/redact3 per call
POST/scan/pii2 per call
POST/sign5 per envelope
POST/validate/pdfa2 per call
POST/validate/pdfua2 per call
POST/validate/signature2 per call
POST/workflows/:id/run1 per call
ai.chat2 per call
convert.html_to_pdf4 per page
convert.office_to_pdf10 per page
convert.pdf_to_office12 per page
convert.pdfa8 per page
esign.envelope750 per envelope
pdf.ocr3 per page
pdf.ocr.high8 per page