API

Detektér en fil

Tjek en fil mod de aktive mærker i et Business- eller Enterprise-arbejdsområde.

POST/api/v1/detect

Tjekker en fil i denne nøgles arbejdsområde. Brødteksten er multipart/form-data.

Godkendelse

Authorization: Bearer mf_…

Send denne header. Der er ingen sessionscookie. curl og andre serverklienter accepteres. En browser på et andet websted afvises.

Parametre

NavnTypePåkrævetBeskrivelse
filefileJaFilen, der skal tjekkes. Der søges kun efter et match i denne nøgles arbejdsområde. En fil mærket i et andet arbejdsområde genkendes ikke. Et aktivt Business- eller Enterprise-arbejdsområde kan også tjekke en videofil. Et skærmbillede af ét enkelt videobillede tjekkes som et billede.

Forespørgsel

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 er den identifikator, du valgte, da kopien blev mærket, eller null, når dette arbejdsområde ikke har et match. confidence er 99 % for en nøjagtig fil, eller når et godkendt mærke stemmer overens med et andet mærke. Et match kun fra det visuelle ligger lavere. layers viser lagene, og hit er true for dem, der stemte overens. notes beskriver, hvad tjekket gjorde. En slettet fil genkendes ikke.

Fejl

Teksten i feltet error i JSON-svaret er på engelsk.

StatusBeskrivelse
400Filen er tom.
401Nøglen mangler, er tilbagekaldt eller er ukendt. JSON-svaret indeholder "code": "api-key".
403Arbejdsområdet har ikke længere en aktiv Business- eller Enterprise-plan (svaret indeholder "code": "enterprise"), eller browseren sendte en cross-site- eller same-site-forespørgsel.
413Filen er over planens uploadgrænse, eller PDF'en har flere sider, end planen tillader.
422Filen kunne ikke behandles.
429Denne nøgle har lavet mere end 80 detektioner i det aktuelle minut.

Hastighedsgrænse

80 forespørgsler pr. minut for denne nøgle. Tælleren ligger i produktdatabasen og gælder stadig efter en genstart.