メインコンテンツへスキップ
ABBYY Vantage プラットフォームは、インテリジェントな文書処理をアプリケーションに統合するために 2 つの REST API を提供しています。

Processing API

文書の送信、トランザクションの管理、抽出データの取得に使用します

Reporting API

分析およびビジネスレポート用のデータにアクセスするために使用します

​
ベース URL

すべての API リクエストは、Vantage の本番環境サーバーに送信されます。

​
認証

Vantage API では認証に OAuth 2.0 を使用します。すべてのリクエストには、Authorization ヘッダーにアクセストークンを含める必要があります。 
Authorization: Bearer {your_access_token}
Vantage では、次の 3 つの認証フローをサポートしています。
フロー最適な用途
Resource Owner Password Credentialsサーバー間の統合
Authorization Code Flowユーザー向けアプリケーション
Client Credentialsマシン間通信
ABBYY Vantage のテナント発行を依頼するには、ABBYY に連絡してください。テナントアカウントを取得したら、認証用のユーザーアカウントと API クライアントを作成できます。

​
Processing API

Processing API (/api/publicapi/v1/) を使用すると、次のことができます：
  • トランザクションの作成 — 特定の Skill を使用してドキュメントを処理用に送信する
  • ファイルの管理 — ドキュメント画像のアップロード、編集、整理を行う
  • ステータスの追跡 — トランザクションの進行状況を監視し、エラーを処理する
  • 結果の取得 — 抽出されたデータを JSON または XML 形式でダウンロードする
  • カタログの管理 — データ カタログおよびルックアップ テーブルを管理する

​
一般的なワークフロー

アップロードから処理、結果の取得までを自動的に行う単一のリクエストでドキュメントを処理します。詳細を見る →
ドキュメントのアップロード、処理、結果の取得をきめ細かく制御するために、個別の API 呼び出しを使用します。詳細を見る →
人による検証が必要なドキュメント向けに、ワークフローに手動確認を組み込みます。詳細を見る →

​
Reporting API

Reporting API (/api/reporting/v2/) では、次の情報にアクセスできます。
  • ビジネス指標 — トランザクション数、処理時間、スループット
  • 品質分析 — 抽出精度と信頼度スコア
  • field レベルのデータ — 分析用の詳細な抽出結果
Reporting の詳細 →

​
出力形式

Vantage は抽出されたデータを構造化された形式で返します。

JSON 出力

抽出結果の詳細と信頼度スコアをすべて含む階層構造データ

XML 出力

XML 連携を必要とするシステム向けの構造化マークアップ形式

​
開発者向けリソース

開発者ガイド

Vantage API との連携方法をまとめた完全ガイド

Postman コレクション

テストや評価にすぐ使える API コレクション

​
レート制限とベストプラクティス

  • バッチ処理 — 複数レコードを処理する場合は、バッチエンドポイントを使用します (1 リクエストあたり最大 5,000 件のカタログレコード)
  • ポーリング — トランザクションのステータスを確認する際は、適切な間隔 (5～10 秒) でポーリングします
  • エラー処理 — 一時的なエラーに対しては、指数バックオフを伴うリトライロジックを実装します

​
次のステップ

1

認証を設定する

アプリケーション向けに OAuth 2.0 を構成します
2

最初のドキュメントを処理する

処理ガイド に従ってドキュメントを送信します
3

API を確認する

Processing API と Reporting API の完全なリファレンスを参照します