跳轉到主要內容
ABBYY Vantage 平台提供兩個 REST API,可將智慧型文件處理整合到您的應用程式中:

基底 URL

所有 API 請求都會發送到 Vantage 的正式環境伺服器:

驗證

Vantage API 使用 OAuth 2.0 進行身分驗證。每個請求都必須在 Authorization 標頭中包含存取權杖:
Authorization: Bearer {your_access_token}
Vantage 支援三種驗證流程:
Flow最適用於
Resource Owner Password Credentials伺服器對伺服器整合
Authorization Code Flow面向使用者的應用程式
Client Credentials機器對機器通訊
聯絡 ABBYY 以申請 ABBYY Vantage 的租戶。取得租戶帳戶後,您即可建立使用者帳戶與 API 用戶端供驗證使用。

Processing API

Processing API (/api/publicapi/v1/) 可讓您:
  • Create transactions — 使用特定 skill 將文件提交以進行處理
  • Manage files — 上傳、編輯及整理文件影像
  • Track status — 監控處理作業進度並處理錯誤情況
  • Retrieve results — 下載 JSON 或 XML 格式的擷取資料
  • Manage catalogs — 管理資料目錄與對照表

常見工作流程

使用單一請求處理文件,自動完成上傳、處理與結果取得。深入了解 →
使用多個 API 呼叫,對文件上傳、處理與結果取得進行更細緻的控制。深入了解 →
將手動審核整合到您的工作流程中,以處理需要人工核驗的文件。深入了解 →

報表 API

報表 API(/api/reporting/v2/)可存取:
  • 營運指標 — 處理作業量、處理時間與吞吐量
  • 品質分析 — 擷取準確度與信心分數
  • 欄位層級資料 — 用於分析的詳細擷取結果
深入了解報表 API →

輸出格式

Vantage 會以結構化格式傳回擷取的資料:

開發人員資源

速率限制與最佳實務

  • 批次作業 — 在處理多筆紀錄時請使用批次 API 端點(每個請求最多可處理 5,000 筆型錄紀錄)
  • 輪詢 — 查詢處理作業狀態時,請使用合理的間隔(5–10 秒)
  • 錯誤處理 — 對暫時性錯誤實作具指數退避機制的重試邏輯

後續步驟

1

設定驗證機制

為您的應用程式設定 OAuth 2.0
2

處理您的第一份文件

依照處理指南提交文件
3

探索 API

瀏覽完整的 Processing APIReporting API 參考說明