搭建可靠的脱敏 API 流程
上传、创建任务、查询和下载,避免重复处理。

准备选择模式处理使用结果
上传并保存标识
在服务端使用 Bearer 密钥,通过 POST /v1/files 上传,保存返回的 file_id。再通过 POST /v1/redactions 传入模式和 Idempotency-Key 创建任务。将文件 ID、任务 ID 与创建键一同保存,避免连接失败后应用无法判断已提交内容。
重试具体操作,而非整个流程
如果创建响应丢失,使用相同文件、模式和幂等键恢复同一请求,不要每次重试都生成新键。查询状态时,可对临时连接问题做有限重试和退避。遇到 429 应暂停并遵守服务容量限制,而不是快速追加任务。
区分请求成功与任务成功
状态查询返回 HTTP 200,也可能描述失败任务。请检查任务 status 和 error 字段。queued 或 running 继续查询,仅在 completed 后下载。本地等待到期不会取消服务器处理,应保留任务 ID 以便恢复查询,且不要在自动降级流程中发送原始文件。
使用所属凭据下载
结果地址受保护。应使用同一所属方的凭据下载,并在保留窗口结束前保存。试用密钥绑定会话,最长有效 24 小时。MCP 客户端先通过 REST 上传,再调用 redact_file 和 get_result。快速开始提供可运行的 Python 示例,API 参考说明错误约定。
进入下一步前
- 保存文件 ID、任务 ID 与幂等键。
- 使用有限轮询与退避。
- 检查任务状态,不只看 HTTP 状态。
- 不要将凭据写进前端代码。