DocUnwrap 文档
开发文档

API Key 管理

创建与管理 DocUnwrap API Key —— MCP 与 REST API 的共同前置。

API Key 是程序化访问 DocUnwrap 的唯一凭证:MCP 端点与 REST API 用同一把 key, 权限、计费与限流语义完全一致。

创建 Key

  1. 登录后进入 应用 → 设置 → API Keys(路径 /app/api-keys,中文站 /zh/app/api-keys)。
  2. 点击创建,输入名称(如 claude-mcp、ci-script)。
  3. 明文 key 只在创建那一刻显示一次,请立即保存到你的密钥管理器。

key 形如 docunwrap_live_xxxx…。每用户最多 20 把,可随时启停/删除。

使用 Key

两种请求头等价,任选其一:

Authorization: Bearer docunwrap_live_xxxx     # 通用写法
x-api-key: docunwrap_live_xxxx                # MCP/REST 均接受

MCP 端点额外接受 URL 查询参数 ?key=docunwrap_live_xxxx —— 供只能填 URL、 塞不进请求头的客户端使用(典型:claude.ai 自定义连接器)。请求头优先于查询参数。

限流与并发

  • 每 key 限流:60 次 / 60 秒,超限返回 429 rate_limited(带 retry_after)。
  • 每用户并发任务闸:进行中(pending/processing)任务达到上限后拒建, 返回 429 too_many_active_tasks(带 retry_after_seconds: 30)。
  • MCP 的 parse_document 等待轮询发生在服务端,不消耗你的请求配额 —— 一次 tools/call 只算 1 次请求,无论等多久。

安全守则

  • key 只放服务端环境变量或本地密钥存储,绝不提交进仓库。
  • 怀疑泄露立即在控制台删除该 key(删除即失效,创建新的替换)。
  • 每个用途一把独立 key(MCP 一把、CI 一把),方便单独吊销与审计。

On this page