ベース URL
認証
ABBYY Vantage のテナント発行を依頼するには、ABBYY に連絡してください。テナントアカウントを取得したら、認証用のユーザーアカウントと API クライアントを作成できます。
Processing API
/api/publicapi/v1/) を使用すると、次のことができます：
- トランザクションの作成 — 特定の Skill を使用してドキュメントを処理用に送信する
- ファイルの管理 — ドキュメント画像のアップロード、編集、整理を行う
- ステータスの追跡 — トランザクションの進行状況を監視し、エラーを処理する
- 結果の取得 — 抽出されたデータを JSON または XML 形式でダウンロードする
- カタログの管理 — データ カタログおよびルックアップ テーブルを管理する
一般的なワークフロー
- 単一のAPI呼び出しによるドキュメント処理 — アップロード、処理、結果の取得を自動的に行う単一のリクエストで、ドキュメントを処理します。
- 個別のAPI呼び出しによるドキュメント処理 — ドキュメントのアップロード、処理、結果の取得をきめ細かく制御するには、個別のAPI呼び出しを使用します。
- 手動確認の統合 — 人による確認が必要なドキュメント向けに、ワークフローへ手動確認を組み込みます。
Reporting API
/api/reporting/v2/) では、次の情報にアクセスできます。
- ビジネス指標 — トランザクション数、処理時間、スループット
- 品質分析 — 抽出精度と信頼度スコア
- field レベルのデータ — 分析用の詳細な抽出結果
出力形式
開発者向けリソース
- Vantage API を使い始める — まずはここから — 最初のAPI呼び出しを行い、認証し、処理シナリオを選択します
- Postman コレクション — テストや評価にすぐ使える API コレクション
レート制限とベストプラクティス
- バッチ処理 — 複数レコードを処理する場合は、バッチエンドポイントを使用します (1 リクエストあたり最大 5,000 件のカタログレコード)
- ポーリング — トランザクションのステータスを確認する際は、適切な間隔 (5～10 秒) でポーリングします
- エラー処理 — 一時的なエラーに対しては、指数バックオフを伴うリトライロジックを実装します
次のステップ
1
認証を設定する
アプリケーション向けに OAuth 2.0 を構成します
2
最初のドキュメントを処理する
処理ガイド に従ってドキュメントを送信します
3
API を確認する
Processing API と Reporting API の完全なリファレンスを参照します