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 次。计数存在产品数据库,重新启动后仍在。