跳转到主要内容
ABBYY Vantage 平台提供两个 REST API,用于将智能文档处理集成到您的应用程序中:

基本 URL

所有 API 请求都发送到 Vantage 生产服务器:

身份验证

Vantage API 使用 OAuth 2.0 进行身份验证。每个请求必须在 Authorization 请求头中包含访问令牌:
Authorization: Bearer {your_access_token}
Vantage 支持三种身份验证流程:
流程最适合
Resource Owner Password Credentials服务器到服务器的集成
Authorization Code Flow面向用户的应用程序
Client Credentials机器与机器之间的通信
如需在 ABBYY Vantage 中申请租户,请联系 ABBYY。获得租户账户后,您可以创建用于身份验证的用户账户和 API 客户端。

处理 API

处理 API (/api/publicapi/v1/) 使您能够:
  • 创建事务 — 使用特定技能提交文档进行处理
  • 管理文件 — 上传、编辑和组织文档图像
  • 跟踪状态 — 监控事务进度并处理错误
  • 获取结果 — 以 JSON 或 XML 格式下载提取的数据
  • 管理目录 — 使用数据目录和查找表

常见工作流

使用单个请求处理文档,自动完成上传、处理和结果获取。了解更多 →
使用多个独立的 API 调用,对文档上传、处理和结果获取进行精细化控制。了解更多 →
在工作流中纳入人工审核,以处理需要人工核验的文档。了解更多 →

Reporting API

Reporting API(/api/reporting/v2/)可用于访问:
  • 业务度量指标 — 事务量、处理时间和吞吐量
  • 质量分析 — 提取准确率和置信度评分
  • 字段级数据 — 用于分析的详细提取结果
详细了解 Reporting →

输出格式

Vantage 以结构化格式返回提取的数据:

开发者资源

速率限制与最佳实践

  • 批量操作 — 在处理多条记录时使用批量接口(每个请求最多 5,000 条目录记录)
  • 轮询 — 在检查事务状态时,使用合理的间隔(5–10 秒)
  • 错误处理 — 对暂时性错误实现采用指数退避策略的重试逻辑

后续步骤

1

设置身份验证

为您的应用程序配置 OAuth 2.0
2

处理您的第一个文档

按照处理指南提交文档
3

探索 API

浏览完整的 Processing APIReporting API 参考文档