API
API
סמן קבצים וזהה אותם ב-API של Markedfile. זמין רק בתוכניות Business ו-Enterprise.
מפתחות API
בעלי סביבת עבודה של Business או Enterprise יוצר ומבטל מפתחות בהגדרות סביבת העבודה. המפתח מוצג פעם אחת. Markedfile שומר גיבוב SHA-256, קידומת קצרה ואת השם. הוא לא שומר את הסוד.
המפתח שייך לסביבת עבודה אחת בדיוק. הוא עובד שם בלבד, במגבלות התוכנית של סביבת העבודה. לסביבות עבודה אישיות אין מפתחות. חבר שאינו הבעלים לא יכול ליצור או לבטל אותם.
אם סביבת העבודה מאבדת תוכנית Business או Enterprise פעילה, כל המפתחות מפסיקים לעבוד מיד, גם במהלך 30 הימים שבהם הקבצים הנוכחיים נשארים ניתנים לזיהוי באפליקציה. חזרה ל-Business או ל-Enterprise מחזירה לפעולה מפתחות שלא בוטלו.
אימות
שלח את הסוד בכותרת Authorization כאסימון Bearer. הנתיבים האלה לא משתמשים בעוגיית הפעלה. דפדפן באתר אחר נדחה.
ביקורת
יצירה, ביטול, סימון וזיהוי כותבים שורת ביקורת שבעלי סביבת העבודה יכול לקרוא. השורה לא כוללת את הקובץ.
נתיבים
POST/api/v1/mark
מסמן קובץ ומחזיר את העותק המסומן. הגוף הוא multipart/form-data.
אימות
Authorization: Bearer mf_…שלח את הכותרת הזו. אין עוגיית הפעלה. curl ולקוחות שרת אחרים מתקבלים. דפדפן באתר אחר נדחה.
פרמטרים
| שם | סוג | חובה | תיאור |
|---|---|---|---|
| file | file | כן | הקובץ לסימון. Business ו-Enterprise מקבלים עד 100 MB, 500 עמודי PDF, ווידאו עד 10 דקות. גודל ההעלאה, אורך הווידאו ומספר עמודי ה-PDF עוקבים אחרי תוכנית סביבת העבודה. |
| identifier | string | כן | 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 בקשות בדקה למפתח הזה. המונה נשמר במסד הנתונים של המוצר ונשאר אחרי הפעלה מחדש.
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 בקשות בדקה למפתח הזה. המונה נשמר במסד הנתונים של המוצר ונשאר אחרי הפעלה מחדש.