- POST /api/v1/jobs - إنشاء عملية PDF من ملف وخيارات الأداة.
- GET /api/v1/jobs/{id} - قراءة الحالة ونسبة التقدم ورسالة الخطأ عند وجودها.
- GET /api/v1/jobs/{id}/download - تنزيل النتيجة عبر رابط مؤقت بعد الاكتمال.
BayanPDF
ابدأ التكامل بخطوات واضحة
صُممت واجهات API حتى تكون قابلة للاختبار، آمنة، ومفهومة للمطورين.
- أرسل `Idempotency-Key` عند أي طلب قابل للإعادة.
- لا ترسل ملفات ضخمة من الذاكرة كاملة؛ استخدم رفعًا منظمًا وحدودًا واضحة.
- تحقق من توقيع Webhook وتجاهل الأحداث المكررة بأمان.
- 400 - خيارات غير صحيحة أو ملف غير مدعوم.
- 401/403 - مفتاح مفقود أو صلاحية غير كافية.
- 429 - تم تجاوز حد الطلبات، انتظر أو استخدم خطة أعلى.
الأسئلة الشائعة
معلومات مختصرة
نعم، المسارات العامة للتكامل تبدأ من `/api/v1` حتى يمكن تطوير الإصدارات لاحقًا بدون كسر التكامل.
نعم. يجب التحقق من التوقيع وتجاهل الأحداث المكررة أو غير المتوقعة.
لا. سجلات التكامل لا يجب أن تحتوي محتوى الملفات أو النصوص المستخرجة أو كلمات المرور.