API

Označ soubor

Označ soubor v pracovním prostoru Business nebo Enterprise a stáhni označenou kopii.

POST`/api/v1/mark`

Označí soubor a vrátí označenou kopii. Tělo je multipart/form-data.

Ověření

Authorization: Bearer mf_…

Pošli tenhle hlavičkový řádek. Není tu soubor cookie relace. curl a další serveroví klienti se přijímají. Prohlížeč na jiné stránce se odmítá.

Parametry

Název	Typ	Povinné	Popis
file	file	Ano	Soubor k označení. Business a Enterprise přijímají až 100 MB, 500 stran PDF a video až 10 minut. Velikost nahrání, délka videa a počet stran PDF vyplývají z tarifu prostoru.
identifier	string	Ano	1–32 znaků, bez řídicích znaků. To je štítek, který uvidíš, když se tahle kopie později zjistí. Do souboru se nezapisuje jako čitelný text.

Požadavek

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

Odpověď

{
  "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 jsou označené bajty v base64. mime, name a kind popisují stažení. layers ukazuje použité vrstvy. Když tarif nemá limit aktivních souborů, remaining je počet aktivních souborů po tomhle označení. Když limit je, remaining je počet zbývajících nových označení. Business a Enterprise nemají limit aktivních souborů. Smazání souboru ukončí detekci.

Chyby

Text pole error v odpovědi JSON je anglicky.

Stav	Popis
400	Soubor je prázdný, nebo je identifikátor prázdný, delší než 32 znaků, nebo obsahuje řídicí znak.
401	Chybí klíč, klíč je zneplatněný, nebo je neznámý. Odpověď JSON obsahuje "code": "api-key".
403	Pracovní prostor už nemá aktivní tarif Business nebo Enterprise (odpověď obsahuje "code": "enterprise"), nebo prohlížeč poslal požadavek cross-site nebo same-site.
413	Soubor překračuje limit nahrávání tarifu, nebo má PDF víc stran, než tarif dovoluje.
422	Soubor se nepodařilo zpracovat.
429	Tenhle klíč označil víc než 40 souborů v běžné minutě.

Limit volání

40 požadavků za minutu pro tenhle klíč. Počítadlo je v databázi produktu a zůstane po restartu.