API

Havaitse tiedosto

Tarkista tiedosto Business- tai Enterprise-työtilan aktiivisia merkintöjä vasten.

POST`/api/v1/detect`

Tarkistaa tiedoston tämän avaimen työtilassa. Runko on multipart/form-data.

Todennus

Authorization: Bearer mf_…

Lähetä tämä otsikko. Istuntoevästettä ei ole. curl ja muut palvelinasiakkaat hyväksytään. Toisella sivustolla oleva selain evätään.

Parametrit

Nimi	Tyyppi	Pakollinen	Kuvaus
file	file	Kyllä	Tarkistettava tiedosto. Osumaa etsitään vain tämän avaimen työtilasta. Toisessa työtilassa merkittyä tiedostoa ei tunnisteta. Aktiivinen Business- tai Enterprise-työtila voi myös tarkistaa videotiedoston. Yhden kuvan kuvakaappaus tarkistetaan kuvana.

Pyyntö

curl -X POST https://markedfile.com/api/v1/detect \
  -H "Authorization: Bearer mf_…" \
  -F "file=@leaked.pdf"

Vastaus

{
  "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 on tunniste, jonka annoit, kun kopio merkittiin, tai null, kun tällä työtilalla ei ole osumaa. confidence on 99 % tarkalle tiedostolle, tai kun todennettu merkki täsmää toiseen merkkiin. Pelkkä visuaalinen osuma jää alemmas. layers näyttää kerrokset, ja hit on true niille, jotka täsmäsivät. notes kuvaa, mitä tarkistus teki. Poistettua tiedostoa ei tunnisteta.

Virheet

JSON-vastauksen error-kentän teksti on englanniksi.

Tila	Kuvaus
400	Tiedosto on tyhjä.
401	Avain puuttuu, on peruutettu tai on tuntematon. JSON-vastaus sisältää "code": "api-key".
403	Työtilalla ei ole enää aktiivista Business- tai Enterprise-pakettia (vastaus sisältää "code": "enterprise"), tai selain lähetti cross-site- tai same-site-pyynnön.
413	Tiedosto ylittää paketin latausrajan, tai PDF:ssä on enemmän sivuja kuin paketti sallii.
422	Tiedostoa ei voitu käsitellä.
429	Tämä avain on tehnyt yli 80 havaitsemista meneillään olevan minuutin aikana.

Kutsuraja

80 pyyntöä minuutissa tälle avaimelle. Laskuri on tuotetietokannassa ja pysyy voimassa uudelleenkäynnistyksen jälkeen.