API

Merk en fil

Merk en fil i et arbeidsområde Business eller Enterprise, og last ned den merkede kopien.

POST`/api/v1/mark`

Merker en fil og returnerer den merkede kopien. 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

Navn	Type	Obligatorisk	Beskrivelse
file	file	Ja	Filen som merkes. Business og Enterprise godtar opptil 100 MB, 500 PDF-sider og video opptil 10 minutter. Opplastingsstørrelse, videolengde og antall PDF-sider følger planen for arbeidsområdet.
identifier	string	Ja	1 til 32 tegn, uten kontrolltegn. Dette er etiketten du ser hvis denne kopien detekteres senere. Den skrives ikke inn i filen som lesbar tekst.

Forespørsel

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

Svar

{
  "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 er de merkede bytene i base64. mime, name og kind beskriver nedlastingen. layers nevner lagene som ble brukt. Hvis planen ikke har en grense for aktive filer, er remaining antallet aktive filer etter denne merkingen. Hvis den har en grense, er remaining hvor mange nye merkinger som er igjen. Business og Enterprise har ingen grense for aktive filer. Sletting av en fil avslutter deteksjonen.

Feil

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

Status	Beskrivelse
400	Filen er tom, eller kjennetegnet er tomt, har mer enn 32 tegn eller inneholder et kontrolltegn.
401	Nøkkelen mangler, er trukket tilbake eller er ukjent. JSON-kroppen inneholder "code": "api-key".
403	Arbeidsområ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.
413	Filen er over opplastingsgrensen for planen, eller PDF-en har flere sider enn planen tillater.
422	Filen kunne ikke behandles.
429	Denne nøkkelen har merket mer enn 40 filer i det inneværende minuttet.

Forespørselsgrense

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