MAXScanner API v1
ابنِ مسارات عمل للمستندات، لا بنية تحتية للمعالجة.
واجهات برمجية غير متزامنة أولًا للمستندات والملفات وOCR والتحويل وPDF والضغط وخطافات الويب. نموذج مصادقة واحد، ودورة حياة واحدة للمهام، وعقد نتائج واحد.
المصادقة
مفاتيح API محدودة النطاق
المعالجة
مهام غير متزامنة
الأحداث
خطافات ويب موقّعة
المرجع
جميع عمليات API
/api/v1/jobsإنشاء مهمة معالجة
أرسل عملية معالجة غير متزامنة واحصل على معرّف مهمة ثابت.
/api/v1/jobs/{jobId}الحصول على حالة المهمة
اقرأ الحالة الحالية لدورة حياة مهمة المعالجة ومعلومات نتيجتها.
/api/v1/documentsعرض المستندات
يعرض المستندات المتاحة للحساب الذي تمت مصادقته.
/api/v1/documents/{documentId}/processمعالجة مستند
أنشئ مهمة معالجة غير متزامنة لإصدار مستند يملكه الحساب.
/api/v1/files/uploadتفويض رفع ملف
أنشئ مسار رفع محدود لملف مصدري خاص.
/api/v1/convertتحويل ملف
وجّه تحويل مستند مدعوم عبر مجموعة المعالجات المُدارة.
/api/v1/ocrتشغيل OCR
استخرج نصًا قابلًا للبحث من صورة أو مستند مدعوم.
/api/v1/pdfتشغيل عملية PDF
أرسل عملية PDF مدعومة مثل الدمج أو التقسيم أو التحسين.
/api/v1/compressضغط صورة
أرسل مهمة تحسين صورة مع قيود على الصيغة والجودة.
/api/v1/webhooksإنشاء خطاف ويب
سجّل وجهة استدعاء موقّعة لأحداث المهام والمستندات.
Error referenceمرجع الأخطاء
افهم أخطاء المصادقة والتحقق والحصة والتعارض والخادم.
Limits & formatsالحدود والصيغ
راجع الصيغ المدعومة والحصص وقيود الطلبات.