API

Detekter en fil

Kontroller en fil mot de aktive merkene i et arbeidsområde Business eller Enterprise.

POST/api/v1/detect

Kontrollerer en fil i arbeidsområdet til denne nøkkelen. Kroppen er multipart/form-data.

Autentisering

Authorization: Bearer mf_…

Send denne headeren. Det finnes ingen øktinformasjonskapsel. curl og andre serverklienter godtas. En nettleser på et annet nettsted avvises.

Parametere

NavnTypeObligatoriskBeskrivelse
filefileJaFilen som kontrolleres. Treffet søkes bare i arbeidsområdet til denne nøkkelen. En fil som er merket i et annet arbeidsområde, gjenkjennes ikke. Et aktivt arbeidsområde Business eller Enterprise kan også kontrollere en videofil. Skjermbildet av ett bilde kontrolleres som et bilde.

Forespørsel

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 kjennetegnet du satte da denne kopien ble merket, eller null hvis dette arbeidsområdet ikke har et treff. confidence er 99 % for en nøyaktig fil, eller når et autentisert merke stemmer med et annet merke. Et bare visuelt treff forblir lavere. layers nevner lagene, og hit er true på lagene som stemte. notes beskriver hva kontrollen gjorde. En slettet fil gjenkjennes ikke.

Feil

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

StatusBeskrivelse
400Filen er tom.
401Nøkkelen mangler, er trukket tilbake eller er ukjent. JSON-kroppen inneholder "code": "api-key".
403Arbeidsområdet har ikke lenger en aktiv plan Business eller Enterprise (kroppen inneholder "code": "enterprise"), eller nettleseren sendte en cross-site- eller same-site-forespørsel.
413Filen er over opplastingsgrensen for planen, eller PDF-en har flere sider enn planen tillater.
422Filen kunne ikke behandles.
429Denne nøkkelen har kjørt mer enn 80 deteksjoner i det inneværende minuttet.

Forespørselsgrense

80 forespørsler per minutt for denne nøkkelen. Telleren ligger i produktdatabasen og gjelder fortsatt etter en omstart.