API

تعليم ملف

علّم ملفاً في مساحة عمل Business أو Enterprise ونزّل النسخة المعلَّمة.

POST/api/v1/mark

يعلّم ملفاً ويعيد النسخة المعلَّمة. الجسم بصيغة multipart/form-data.

المصادقة

Authorization: Bearer mf_…

أرسل هذه الترويسة. لا يوجد ملف تعريف ارتباط للجلسة. يُقبل curl وعملاء الخادم الآخرون. يُرفض متصفح على موقع آخر.

المعاملات

الاسمالنوعمطلوبالوصف
filefileنعمالملف المراد تعليمه. تقبل Business و Enterprise حتى 100 MB، و500 صفحة PDF، وفيديو حتى 10 دقائق. يتبع حجم الرفع ومدة الفيديو وعدد صفحات PDF خطة مساحة العمل.
identifierstringنعممن 1 إلى 32 محرفاً، من دون محارف تحكم. التسمية التي تراها أنت إذا كُشفت هذه النسخة لاحقاً. لا تُكتب في الملف كنص مقروء.

الطلب

curl -X POST https://markedfile.com/api/v1/mark \
  -H "Authorization: Bearer mf_…" \
  -F "file=@contract.pdf" \
  -F "identifier=northwind"

الاستجابة

{
  "file": "JVBERi0xLjQK…",
  "mime": "application/pdf",
  "name": "contract.pdf",
  "kind": "pdf",
  "layers": [
    {
      "name": "Metadata",
      "detail": "Authenticated workspace reference; the identifier stays on the server",
      "screenshot": "No",
      "crop": "No",
      "reencode": "No"
    }
  ],
  "remaining": 1
}

file هو البايتات المعلَّمة بصيغة base64. يصف mime و name و kind التنزيل. يسرد layers الحوامل التي طُبّقت. حين لا يكون للخطة حد للملفات النشطة، يكون remaining عدد الملفات النشطة بعد هذا التعليم. حين يكون لها حد، يكون remaining عدد العلامات الجديدة المتبقية. ليس لـ Business و Enterprise حد للملفات النشطة. حذف الملف هو ما ينهي الكشف.

الأخطاء

حقل error في جسم JSON بالإنجليزية.

الحالةالوصف
400الملف فارغ، أو المعرّف فارغ أو أطول من 32 محرفاً أو يحتوي محرف تحكم.
401المفتاح مفقود أو ملغى أو غير معروف. يتضمن جسم JSON الحقل "code": "api-key".
403لم تعد مساحة العمل على خطة Business أو Enterprise نشطة (يتضمن الجسم "code": "enterprise")، أو أرسل المتصفح طلباً cross-site أو same-site.
413يتجاوز الملف حد الرفع في الخطة، أو يحتوي PDF على صفحات أكثر مما تسمح به الخطة.
422تعذّر معالجة الملف.
429علّم هذا المفتاح أكثر من 40 ملفاً في الدقيقة الحالية.

حد المعدل

40 طلباً في الدقيقة لهذا المفتاح. يُخزَّن العداد في قاعدة بيانات المنتج ويبقى بعد إعادة التشغيل.