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 בקשות בדקה למפתח הזה. המונה נשמר במסד הנתונים של המוצר ונשאר אחרי הפעלה מחדש.