API

標記檔案

在 Business 或 Enterprise 工作區標記檔案，並取得標記後的副本。

POST/api/v1/mark

在檔案上標記，並交回標記後的副本。本文是 multipart/form-data。

驗證

Authorization: Bearer mf_…

請送出這一行標頭。沒有工作階段 cookie。curl 與其他伺服器用戶端可以。其他頁面的瀏覽器會被拒絕。

參數

名稱類型必填說明
filefile是要標記的檔案。Business 與 Enterprise 接受最多 100 MB、PDF 500 頁，以及最長 10 分鐘的影片。上傳大小、影片長度與 PDF 頁數依工作區方案。
identifierstring是1–32 個字元，不含控制字元。這份副本日後被檢查時會看到的標籤。它不會以可讀文字寫進檔案。

請求

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

回應

{
  "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 是 base64 的標記後位元組。mime、name 與 kind 說明下載檔。layers 顯示寫入的層。方案若沒有有效檔案上限，remaining 是這次標記之後的有效檔案數。若有上限，remaining 是剩下的新標記數。Business 與 Enterprise 沒有有效檔案上限。刪除檔案就結束偵測。

錯誤

JSON 回應裡 error 欄位的文字是英文。

狀態說明
400檔案是空的，或識別碼是空的、超過 32 個字元，或含有控制字元。
401金鑰不存在、已撤銷，或無法辨識。JSON 回應含有 "code": "api-key"。
403工作區沒有有效的 Business 或 Enterprise 方案（回應含有 "code": "enterprise"）。或者瀏覽器送出了 cross-site 或 same-site 請求。
413檔案超過方案的上傳上限，或 PDF 頁數多於方案上限。
422無法處理檔案。
429這把金鑰在目前這一分鐘內標記了超過 40 個檔案。

呼叫上限

這把金鑰每分鐘 40 次。計數存在產品資料庫，重新啟動後仍在。