API

API

Merkitse ja havaitse tiedostoja Markedfilen API:lla. Saatavilla paketeissa Business ja Enterprise.

API-avaimet

Business- tai Enterprise-työtilan omistaja luo ja peruuttaa avaimet työtilan asetuksissa. Avain näytetään vain kerran. Markedfile tallentaa SHA-256-tiivisteen, lyhyen etuliitteen ja nimen. Salaisuutta ei tallenneta.

Avain kuuluu täsmälleen yhteen työtilaan. Se toimii vain siellä, työtilan pakettirajoilla. Henkilökohtaisilla työtiloilla ei ole avaimia. Jäsen, joka ei ole omistaja, ei voi luoda eikä peruuttaa niitä.

Jos työtila menettää aktiivisen Business- tai Enterprise-paketin, kaikki avaimet lakkaavat toimimasta heti, myös niiden 30 päivän aikana, jolloin olemassa olevat tiedostot voidaan yhä havaita sovelluksessa. Kun palaat Business- tai Enterprise-pakettiin, peruuttamattomat avaimet toimivat taas.

Todennus

Lähetä salaisuus Authorization-otsikossa Bearer-tunnuksena. Nämä reitit eivät käytä istuntoevästettä. Toisella sivustolla oleva selain evätään.

Tarkastus

Luonti, peruutus, merkintä ja havaitseminen kirjoittavat tarkastusrivin, jonka työtilan omistaja voi lukea. Rivi ei sisällä tiedostoa.

Päätepisteet

POST/api/v1/mark

Merkitsee tiedoston ja palauttaa merkityn kopion. 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

NimiTyyppiPakollinenKuvaus
filefileKylläMerkittävä tiedosto. Business ja Enterprise hyväksyvät enintään 100 MB, 500 PDF-sivua ja videon enintään 10 minuuttia. Latauskoko, videon pituus ja PDF-sivujen määrä noudattavat työtilan pakettia.
identifierstringKyllä1–32 merkkiä, ilman ohjausmerkkejä. Se on etiketti, jonka näet, jos tämä kopio havaitaan myöhemmin. Sitä ei kirjoiteta tiedostoon luettavana tekstinä.

Pyyntö

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

Vastaus

{
  "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 on merkityt tavut base64-muodossa. mime, name ja kind kuvaavat latausta. layers näyttää käytetyt kerrokset. Kun paketissa ei ole kattoa aktiivisille tiedostoille, remaining on aktiivisten tiedostojen määrä tämän merkinnän jälkeen. Kun katto on, remaining on jäljellä olevien uusien merkintöjen määrä. Businessilla ja Enterprisella ei ole kattoa aktiivisille tiedostoille. Tiedoston poistaminen lopettaa havaitsemisen.

Virheet

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

TilaKuvaus
400Tiedosto on tyhjä, tai tunniste on tyhjä, pidempi kuin 32 merkkiä tai sisältää ohjausmerkin.
401Avain puuttuu, on peruutettu tai on tuntematon. JSON-vastaus sisältää "code": "api-key".
403Työ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.
413Tiedosto ylittää paketin latausrajan, tai PDF:ssä on enemmän sivuja kuin paketti sallii.
422Tiedostoa ei voitu käsitellä.
429Tämä avain on merkinnyt yli 40 tiedostoa meneillään olevan minuutin aikana.

Kutsuraja

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

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

NimiTyyppiPakollinenKuvaus
filefileKyllä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.

TilaKuvaus
400Tiedosto on tyhjä.
401Avain puuttuu, on peruutettu tai on tuntematon. JSON-vastaus sisältää "code": "api-key".
403Työ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.
413Tiedosto ylittää paketin latausrajan, tai PDF:ssä on enemmän sivuja kuin paketti sallii.
422Tiedostoa ei voitu käsitellä.
429Tä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.