API
Detektera en fil
Kontrollera en fil mot de aktiva markeringarna i en Business- eller Enterprise-arbetsyta.
POST/api/v1/detect
Kontrollerar en fil i den här nyckelns arbetsyta. Brödtexten är multipart/form-data.
Autentisering
Authorization: Bearer mf_…Skicka den här headern. Det finns ingen sessionscookie. curl och andra serverklienter accepteras. En webbläsare på en annan webbplats nekas.
Parametrar
| Namn | Typ | Obligatorisk | Beskrivning |
|---|---|---|---|
| file | file | Ja | Filen som ska kontrolleras. Matchningen söks bara i den här nyckelns arbetsyta. En fil som märkts i en annan arbetsyta känns inte igen. En aktiv Business- eller Enterprise-arbetsyta kan också kontrollera en videofil. En skärmbild av en bildruta kontrolleras som en bild. |
Förfrågan
curl -X POST https://markedfile.com/api/v1/detect \
-H "Authorization: Bearer mf_…" \
-F "file=@leaked.pdf"Svar
{
"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 är den identifierare du angav när kopian märktes, eller null när den här arbetsytan inte har en matchning. confidence är 99 % för en exakt fil, eller när en autentiserad markering stämmer överens med en annan markering. En matchning som bara är visuell ligger lägre. layers visar lagren, och hit är true för dem som stämde. notes beskriver vad kontrollen gjorde. En raderad fil känns inte igen.
Fel
Texten i fältet error i JSON-svaret är på engelska.
| Status | Beskrivning |
|---|---|
| 400 | Filen är tom. |
| 401 | Nyckeln saknas, är återkallad eller är okänd. JSON-svaret innehåller "code": "api-key". |
| 403 | Arbetsytan har inte längre en aktiv Business- eller Enterprise-plan (svaret innehåller "code": "enterprise"), eller så skickade webbläsaren en cross-site- eller same-site-förfrågan. |
| 413 | Filen är över planens uppladdningsgräns, eller så har PDF:en fler sidor än planen tillåter. |
| 422 | Filen kunde inte bearbetas. |
| 429 | Den här nyckeln har gjort mer än 80 detekteringar under den pågående minuten. |
Anropsgräns
80 förfrågningar per minut för den här nyckeln. Räknaren ligger i produktdatabasen och gäller fortfarande efter en omstart.