基础 URL
身份验证
Authorization 请求头中包含访问令牌:
| 流程 | 最适用场景 |
|---|---|
| Resource Owner Password Credentials | 服务器与服务器间集成 |
| Authorization Code Flow | 面向用户的应用程序 |
| Client Credentials | 机器对机器通信 |
请联系 ABBYY 以在 ABBYY Vantage 中申请一个租户。获得租户账户后,您可以创建用户账户和用于身份验证的 API 客户端。
处理 API
/api/publicapi/v1/)使您能够:
- 创建处理事务 — 使用特定 Skill 提交文档进行处理
- 管理文件 — 上传、编辑和组织文档图像
- 跟踪状态 — 监控处理事务的进度并处理错误
- 获取结果 — 以 JSON 或 XML 格式下载提取的数据
- 管理数据目录 — 操作数据目录(data catalog)和查找表
常见工作流
单次 API 调用处理
单次 API 调用处理
使用单个请求即可自动完成文档的上传、处理和结果获取。了解更多 →
多步骤处理
多步骤处理
使用多个独立的 API 调用,对文档上传、处理和结果获取进行更精细的控制。了解更多 →
人机协同(Human-in-the-Loop)
人机协同(Human-in-the-Loop)
在工作流中集成人工校验步骤,以处理需要人工校验的文档。了解更多 →
Reporting API
/api/reporting/v2/)提供对以下内容的访问:
- 业务指标 — 事务(Transaction)量、处理时间和吞吐量
- 质量分析 — 提取准确率和置信度评分
- field 级别数据 — 用于分析的详细提取结果
输出格式
开发者资源
速率限制与最佳实践
- 批量操作 — 在处理多条记录时使用批处理端点(每个请求最多 5,000 条目录记录)
- 轮询 — 在检查处理事务状态时,使用合理的轮询间隔(5–10 秒)
- 错误处理 — 对瞬时错误实现带指数退避策略的重试逻辑
