API

Merkitse tiedosto

Merkitse tiedosto Business- tai Enterprise-työtilassa ja lataa merkitty kopio.

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

Nimi	Tyyppi	Pakollinen	Kuvaus
file	file	Kyllä	Merkittävä tiedosto. Business hyväksyy enintään 100 MB, 500 PDF-sivua ja videon enintään 10 minuuttia. Enterprisessa tiedoston koko, PDF-sivut, videon pituus ja videotiedoston koko ovat Räätälöity. Latauskoko, videon pituus ja PDF-sivujen määrä noudattavat työtilan pakettia.
identifier	string	Kyllä	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.

Tila	Kuvaus
400	Tiedosto on tyhjä, tai tunniste on tyhjä, pidempi kuin 32 merkkiä tai sisältää ohjausmerkin.
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ä.
503	Palvelin on varattu, tai merkintä on tauolla huollon vuoksi.
429	Tä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.