API
זיהוי קובץ
בדוק קובץ מול הסימנים הפעילים בסביבת עבודה של Business או Enterprise.
POST/api/v1/detect
בודק קובץ בתוך סביבת העבודה של המפתח. הגוף הוא multipart/form-data.
אימות
Authorization: Bearer mf_…שלח את הכותרת הזו. אין עוגיית הפעלה. curl ולקוחות שרת אחרים מתקבלים. דפדפן באתר אחר נדחה.
פרמטרים
| שם | סוג | חובה | תיאור |
|---|---|---|---|
| file | file | כן | הקובץ לבדיקה. ההתאמה נחפשת רק בסביבת העבודה של המפתח. קובץ שסומן בסביבת עבודה אחרת לא נפתר. סביבת עבודה פעילה של Business או Enterprise יכולה גם לבדוק קובץ וידאו. צילום מסך של פריים אחד נבדק כתמונה. |
בקשה
curl -X POST https://markedfile.com/api/v1/detect \
-H "Authorization: Bearer mf_…" \
-F "file=@leaked.pdf"תשובה
{
"id": "northwind",
"confidence": 0.95,
"layers": [
{
"name": "Metadata",
"hit": true,
"detail": "Authenticated metadata matched this workspace",
"screenshot": "No",
"crop": "No",
"reencode": "No"
}
],
"notes": [
"Confidence is 99% for an exact file or when an authenticated mark agrees with another mark. A visual match alone stays lower, and weak bit agreement stays far from a high score."
]
}id הוא המזהה שהקצית כשהעותק סומן, או null כשאין התאמה לסביבת העבודה. confidence הוא 99% לקובץ תואם בדיוק או כשסימן מאומת מסכים עם סימן אחר. התאמה חזותית לבדה נשארת נמוכה יותר. layers מפרט את הנשאים, ו-hit הוא true על אלה שהסכימו. notes מתאר מה הבדיקה עשתה. קובץ שנמחק לא נפתר.
שגיאות
שדה error בגוף ה-JSON הוא באנגלית.
| סטטוס | תיאור |
|---|---|
| 400 | הקובץ ריק. |
| 401 | המפתח חסר, בוטל או לא מוכר. גוף ה-JSON כולל את השדה "code": "api-key". |
| 403 | סביבת העבודה כבר לא על תוכנית Business או Enterprise פעילה (הגוף כולל "code": "enterprise"), או שהדפדפן שלח בקשת cross-site או same-site. |
| 413 | הקובץ חורג ממגבלת ההעלאה של התוכנית, או שב-PDF יש יותר עמודים ממה שהתוכנית מאפשרת. |
| 422 | לא ניתן לעבד את הקובץ. |
| 429 | המפתח הזה ביצע יותר מ-80 זיהויים בדקה הנוכחית. |
מגבלת קצב
80 בקשות בדקה למפתח הזה. המונה נשמר במסד הנתונים של המוצר ונשאר אחרי הפעלה מחדש.