API

Märk en fil

Märk en fil i en Business- eller Enterprise-arbetsyta och ladda ner den märkta kopian.

POST`/api/v1/mark`

Märker en fil och returnerar den märkta kopian. Brödtexten är multipart/form-data.

Autentisering

Authorization: Bearer mf_…

Skicka den här headern. Det finns ingen sessionscookie. curl och andra serverklienter accepteras. En webbläsare på en annan webbplats nekas.

Parametrar

Namn	Typ	Obligatorisk	Beskrivning
file	file	Ja	Filen som ska märkas. Business och Enterprise accepterar upp till 100 MB, 500 PDF-sidor och video upp till 10 minuter. Uppladdningsstorlek, videolängd och antal PDF-sidor följer arbetsytans plan.
identifier	string	Ja	1 till 32 tecken, utan styrtecken. Det är etiketten du ser om den här kopian detekteras senare. Den skrivs inte in i filen som läsbar text.

Förfrågan

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 är de märkta byten i base64. mime, name och kind beskriver nedladdningen. layers visar de lager som användes. När planen inte har ett tak för aktiva filer är remaining antalet aktiva filer efter den här markeringen. När den har ett tak är remaining hur många nya markeringar som återstår. Business och Enterprise har inget tak för aktiva filer. Att radera en fil avslutar detekteringen.

Fel

Texten i fältet error i JSON-svaret är på engelska.

Status	Beskrivning
400	Filen är tom, eller så är identifieraren tom, längre än 32 tecken eller innehåller ett styrtecken.
401	Nyckeln saknas, är återkallad eller är okänd. JSON-svaret innehåller "code": "api-key".
403	Arbetsytan har inte längre en aktiv Business- eller Enterprise-plan (svaret innehåller "code": "enterprise"), eller så skickade webbläsaren en cross-site- eller same-site-förfrågan.
413	Filen är över planens uppladdningsgräns, eller så har PDF:en fler sidor än planen tillåter.
422	Filen kunde inte bearbetas.
429	Den här nyckeln har märkt mer än 40 filer under den pågående minuten.

Anropsgräns

40 förfrågningar per minut för den här nyckeln. Räknaren ligger i produktdatabasen och gäller fortfarande efter en omstart.