文書処理の進行状況の確認と結果のダウンロード

トランザクションのステータスを確認し、処理結果を含むファイルをダウンロードできます。 transactions/<transaction-id> リソースに GET リクエストを送信します。

GET https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id

GET https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id

GET https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id

次のコマンドを実行します。 Windows の場合:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id" \
-H "Authorization: Bearer token"

Linux の場合:

curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id' \
-H 'Authorization: Bearer token'

現在のトランザクションステータスを含むレスポンスが返されます。 レスポンス:

{
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "status": "Processing",
   "manualReviewLink": "https://vantage-us.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
   "sourceFiles": [
     {
       "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
       "name": "Invoice07.JPG"
     }
   ]
}

{
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "status": "Processing",
   "manualReviewLink": "https://vantage-eu.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
   "sourceFiles": [
     {
       "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
       "name": "Invoice07.JPG"
     }
   ]
}

{
   "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
   "status": "Processing",
   "manualReviewLink": "https://vantage-au.abbyy.com/api/publicapi/v1/verify?documentIds=9838448d-72ae-4e9a-b071-2bb16f732e46",
   "sourceFiles": [
     {
       "id": "7b2eed6f-3fdd-43b9-a178-7211d0a8d5bb",
       "name": "Invoice07.JPG"
     }
   ]
}

status キーには、次のいずれかの値が設定されます。

New は、トランザクションは作成されたものの、処理はまだ開始されていないことを示します。
Processing は、ドキュメントが現在処理中であることを示します。
Processed は、処理が完了しており結果をダウンロードできる状態であることを示します。
Failed は、処理が正常に完了しなかったことを示します。
Canceled は、トランザクションがキャンセルされたことを示します。

ステータスが Processed、Failed、または Canceled になったら、ポーリングを停止します。処理結果を含むファイルをダウンロードするには、transactions/<transaction-id>/files/<file-id>/download リソースに GET リクエストを送信し、トランザクション ID とドキュメントファイル ID を指定します。

GET https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download

GET https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download

GET https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download

ファイル ID は、トランザクションステータスレスポンスの documents[].resultFiles[].fileId 値から取得します。各 resultFiles エントリには、fileId、fileName、type (Json や FieldsJson など) が含まれます。sourceFiles の ID は元のアップロード済みファイルを識別するものであり、別のエンドポイント (documents/<document-id>/sourceFiles/<file-id>/download) からダウンロードします。

次のコマンドを実行します。 Windows の場合:

curl -X GET "https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download" \
-H "Authorization: Bearer token"

curl -X GET "https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download" \
-H "Authorization: Bearer token"

Linux の場合:

curl -X GET 'https://vantage-us.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-eu.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'

curl -X GET 'https://vantage-au.abbyy.com/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'

このコマンドにより、ドキュメントの処理結果が JSON 形式で返されます。

結果は PDF 形式でダウンロードすることもできます。PDF 形式でダウンロードするには、Output アクティビティを選択し、Actions ペインの Exported Data セクションで Settings をクリックして、希望する形式として PDF を選択します。

概要

開発者ガイド

文書処理の進行状況の確認と結果のダウンロード