مرجع API
واجهة برمجة تطبيقات سير العمل
تتطلب جميع نقاط النهاية جلسة مسجّلة (ملف تعريف ارتباط) ما لم يُذكر خلاف ذلك. الردود بصيغة JSON: { ok: true, data } أو { ok: false, error }. الأخطاء الشائعة: 400 خطأ في التحقق، 401 غير مصادق، 403 محظور، 404 غير موجود، 429 تجاوز حد المعدل، 502/503 خادم أعلى. نقاط النهاية العامة /api/v1 تُصادَق باستخدام Authorization: Bearer pdflean_… ويجب أن ترسل نوع محتوى JSON.
على هذه الصفحة
سير العمل
| الطريقة | المسار | الوصف |
|---|---|---|
| GET | /api/workflows | قائمة سير العمل الخاصة بك |
| POST | /api/workflows | إنشاء سير عمل (مسودة) |
| GET | /api/workflows/:id | الحصول على سير عمل |
| PUT | /api/workflows/:id | تحديث سير العمل (مسودة، إصدار+1) |
| DELETE | /api/workflows/:id | حذف سير العمل |
| POST | /api/workflows/:id/publish | نشر إصدار |
| GET | /api/workflows/:id/versions | قائمة الإصدارات |
| POST | /api/workflows/:id/versions/:version/restore | استعادة إصدار |
المشغلات والخطافات
| الطريقة | المسار | الوصف |
|---|---|---|
| GET | /api/workflows/triggers | قائمة المشغلات |
| POST | /api/workflows/triggers | إنشاء مشغل (ويب هوك/جدولة/بريد إلكتروني/Drive) |
| POST | /api/workflows/triggers/:id/run | تشغيل المشغل الآن |
| DELETE | /api/workflows/triggers/:id | حذف مشغل |
| POST | /api/workflows/hook/:token | خطاف ويب وارد (مصادقة بالرمز المميز، بدون جلسة؛ جسم JSON) |
التشغيلات والمراجعات
| الطريقة | المسار | الوصف |
|---|---|---|
| POST | /api/workflows/runs | إنشاء تشغيل (في قائمة الانتظار) |
| GET | /api/workflows/runs | قائمة التشغيلات |
| GET | /api/workflows/runs/:id | تفاصيل التشغيل والخطوات |
| POST | /api/workflows/runs/:id/retry | إعادة محاولة تشغيل فاشل/في قائمة الانتظار |
| GET | /api/workflows/reviews | مراجعات بشرية معلقة |
| POST | /api/workflows/reviews/:id | الموافقة/رفض المراجعة |
جسر السحابة
| الطريقة | المسار | الوصف |
|---|---|---|
| GET | /api/workflows/cloud/status | حالة جسر VPS المستقل |
| POST | /api/workflows/cloud/convert | Office → PDF عبر VPS مستقل (LibreOffice) |
| POST | /api/workflows/cloud/ocr | OCR عبر VPS مستقل (Tesseract) |
| POST | /api/workflows/cloud/extract | استخراج حقول الفاتورة/العامة من PDF (pdfjs + rules) |
الأرشفة والاحتفاظ
| الطريقة | المسار | الوصف |
|---|---|---|
| GET | /api/workflows/archive | قائمة الوثائق المؤرشفة + سلامة السلسلة |
| POST | /api/workflows/archive | أرشفة مستند (base64، سلسلة تجزئة SHA-256) |
| GET | /api/workflows/archive/:id/verify | التحقق من سلسلة التجزئة للأرشيف |
| GET | /api/workflows/archive/export | تصدير سجل تدقيق الأرشيف CSV (يشمل سجلات tombstones) |
| POST | /api/workflows/archive/:id/hold | تعيين/مسح الحجز القانوني |
| POST | /api/workflows/archive/:id/compliance | تمكين قفل الامتثال WORM غير القابل للإلغاء |
| DELETE | /api/workflows/archive/:id | حذف الأرشيف (محظور بموجب حجز قانوني) |
واجهة برمجة تطبيقات عامة v1
| الطريقة | المسار | الوصف |
|---|---|---|
| GET | /api/v1/openapi.json | مواصفات OpenAPI 3.1 (عامة، بدون مصادقة) |
| GET | /api/v1/me | مالك مفتاح API الحالي (مفتاح Bearer) |
| GET | /api/v1/usage | لوحة استخدام: الرصيد، سجل آخر 30 يومًا، المكالمات الأخيرة |
| GET | /api/v1/workflows | قائمة سير العمل (النطاق workflow.read) |
| GET | /api/v1/workflows/:id | الحصول على سير عمل (النطاق workflow.read) |
| POST | /api/v1/workflows/:id/run | وضع تشغيل في قائمة الانتظار (النطاق workflow.run) |
| GET | /api/v1/runs | قائمة التشغيلات (النطاق workflow.read) |
| POST | /api/v1/pdf/merge | دمج ملفات PDF (النطاق pdf.merge؛ من 2 إلى 10 ملفات بترميز base64) |
| POST | /api/v1/pdf/split | الاحتفاظ بالصفحات المحددة (النطاق pdf.split؛ نطاقات مثل "1-3,5") |
| POST | /api/v1/pdf/compress | ضغط ملف PDF هيكليًا (النطاق pdf.compress) |
| GET | /api/v1/jobs/:id | حالة المهمة (مجاني) |
| GET | /api/v1/jobs/:id/download | تحميل نتيجة المهمة (مجاني) |
| POST | /api/v1/convert/office | تحويل مستندات Office/ODF (النطاق pdf.convert) |
| POST | /api/v1/convert/linearize | ترتيب ملف PDF للعرض السريع على الويب (النطاق pdf.convert) |
| POST | /api/v1/convert/typst | تجميع مصدر Typst/Markdown إلى PDF (النطاق pdf.convert) |
| POST | /api/v1/ocr | إجراء OCR لملف PDF ممسوح ضوئيًا إلى PDF قابل للبحث (النطاق pdf.ocr) |
| POST | /api/v1/ocr/text | إجراء OCR لصورة واحدة إلى نص (النطاق pdf.ocr) |
| POST | /api/v1/validate/pdfa | فحص الامتثال لـ PDF/A (النطاق pdf.validate) |
| POST | /api/v1/validate/pdfua | فحص إمكانية الوصول PDF/UA (النطاق pdf.validate) |
| POST | /api/v1/validate/signature | تقرير التحقق من التوقيع الرقمي (النطاق pdf.validate) |
| POST | /api/v1/sign | توقيع رقمي PAdES (النطاق pdf.sign؛ زوج مفاتيح PEM اختياري) |
| POST | /api/v1/redact | إخفاء حقيقي لمطابقات النص أو المناطق (النطاق pdf.redact) |
| POST | /api/v1/extract | استخراج الحقول بناءً على النص والقواعد (النطاق pdf.extract) |
| POST | /api/v1/docling | تحليل التخطيط المنظم عبر Docling (النطاق pdf.extract) |
| POST | /api/v1/scan/pii | فحص النص بحثًا عن المعلومات الشخصية (النطاق 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)
| Method | Endpoint | Credits |
|---|---|---|
| GET | /jobs/:id | 0 per call |
| GET | /jobs/:id/download | 0 per call |
| GET | /me | 0 per call |
| GET | /runs | 0 per call |
| GET | /usage | 0 per call |
| GET | /workflows | 0 per call |
| GET | /workflows/:id | 0 per call |
| POST | /ai/chat | 3 per call |
| POST | /ai/extract | 5 per call |
| POST | /ai/pii-detect | 4 per call |
| POST | /ai/summarize | 3 per call |
| POST | /ai/translate | 3 per call |
| POST | /convert/linearize | 1 per call |
| POST | /convert/office | 2 per call |
| POST | /convert/typst | 1 per call |
| POST | /docling | 3 per call |
| POST | /extract | 2 per call |
| POST | /ocr | 3 per page |
| POST | /ocr/text | 1 per call |
| POST | /pdf/compress | 1 per call |
| POST | /pdf/merge | 1 per call |
| POST | /pdf/split | 1 per call |
| POST | /redact | 3 per call |
| POST | /scan/pii | 2 per call |
| POST | /sign | 5 per envelope |
| POST | /validate/pdfa | 2 per call |
| POST | /validate/pdfua | 2 per call |
| POST | /validate/signature | 2 per call |
| POST | /workflows/:id/run | 1 per call |
| ai.chat | 2 per call | |
| convert.html_to_pdf | 4 per page | |
| convert.office_to_pdf | 10 per page | |
| convert.pdf_to_office | 12 per page | |
| convert.pdfa | 8 per page | |
| esign.envelope | 750 per envelope | |
| pdf.ocr | 3 per page | |
| pdf.ocr.high | 8 per page |