- いずれかのアプリケーションの認証情報を使用して、authorization headerを取得します。authorization headerの取得方法の詳細については、認証セクションを参照してください。
- 有効な入力形式のファイルを、File.Uploadメソッドを使用してサーバーにアップロードします。レスポンスでは、そのファイルに関する以降のすべてのrequestで使用する、ファイルの識別子とトークンが返されます。
リクエスト例
リクエスト例
レスポンス例
レスポンス例
{“id”: “5eeb762149c6470fdc65a84c”,“token”: “4B5A1A00E7A82C2AF31E20CADE7284DDA43DED30”,“name”: “US_1.png”,“extension”: “.png”,“hash”: “E75133BA4FC50B7197C2842D7A8A8AE615C37E38714C7773B1F8E2904EC62537A199129CD3B737673FBAB1DE63CBD5D428705443ADD2E1BA6223B7DD60070FDA”,“size”: 369090,“mime”: “image/png”,“is_recognizable”: true,“account”: “5dae591d3c66a51ae8be9896”,“application”: “5dae591e91375010bcd78362”,“email”: “user@abbyy.com”,“created”: “2020-02-02T14:11:45.5338461Z”,“expiring”: “2020-03-03T14:11:45.5338254Z”}
- データ抽出を開始するには、Task.Runメソッドを使用して処理タスクを開始します。このrequestでは複数のファイルを指定できます。requestには、次の任意parametersを含めることができます: 請求書の地域、verification type、および結果のエクスポート形式です。
リクエスト例
リクエスト例
curl -X POST —header “Content-Type: application/json” —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l” -d ”{“properties”: {“region”: “US”,“export_format”: “Xls”,“verification_type”: “NoVerification”,},“files”: [{“id”: “5eeb762149c6470fdc65a84c”,“token”: “4B5A1A00E7A82C2AF31E20CADE7284DDA43DED30”}]}” “https://api-eu.flexicapture.com/v2/task/capture/invoices”
レスポンス例
レスポンス例
{“id”: “5eeb7bf728613d1e04a70782”,“number”: “1126563”,“batch_id”: 0,“type”: “ic”,“is_realtime_enabled”: false,“processing_priority”: “Normal”,“is_demo”: false,“properties”: {“region”: “US”,“export_format”: “Xls”,“verification_type”: “NoVerification”},“account”: “5dae591d3c66a51ae8be9896”,“email”: “user@abbyy.com”,“application”: “5dae591e91375010bcd78362”,“created”: “2020-02-02T14:36:39.441Z”,“progress”: 0,“status”: “Submitted”,“is_deleted”: false,“is_billed”: false,“documents”: [{“files”: {“source”: {“id”: “5eeb762149c6470fdc65a84c”,“token”: “4B5A1A00E7A82C2AF31E20CADE7284DDA43DED30”,“name”: “US_1.png”}},“data”: {},“is_moved”: false}],“is_extra_error”: false}
- タスクの処理にはしばらく時間がかかるため、抽出データをすぐに利用することはできません。タスクの開始時に受け取った識別子を使用して、タスクのステータスを確認できます。ステータスが Done に変わるまで待機してください。タスクのステータスを確認するには、Task.Get メソッドを使用してください。
リクエスト例
リクエスト例
curl -X GET —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l” “https://api-eu.flexicapture.com/v2/task/5eeb7bf728613d1e04a70782
レスポンス例
レスポンス例
{“id”: “5eeb7bf728613d1e04a70782”,“number”: “1126563”,“batch_id”: 2640691,“type”: “ic”,“is_realtime_enabled”: false,“processing_priority”: “Normal”,“is_demo”: false,“properties”: {“region”: “US”,“export_format”: “Xls”,“verification_type”: “NoVerification”},“account”: “5dae591d3c66a51ae8be9896”,“email”: “user@abbyy.com”,“application”: “5dae591e91375010bcd78362”,“created”: “2020-02-02T14:36:39.441Z”,“started”: “2020-02-02T14:36:50.308Z”,“billed”: “2020-02-02T14:37:14.35Z”,“delivered”: “2020-02-02T14:37:14.328Z”,“progress”: 100,“status”: “Done”,“is_deleted”: false,“is_billed”: true,“documents_count”: 1,“pages_count”: 1,“documents”: [{“files”: {“source”: {“id”: “5eeb762149c6470fdc65a84c”,“token”: “4B5A1A00E7A82C2AF31E20CADE7284DDA43DED30”,“name”: “US_1.png”},“target”: {“id”: “5eeb7c1963ee5a1268123b96”,“token”: “A01EFC05BBB787DC6825F08E51B56CF3E066210E”,“name”: “Data_00000001.xls”},“verification_layer_page_0”: {“id”: “5eeb7c1a63ee5a1268123b97”,“token”: “18921FFB4C944056CB3ED00768F90724ADF0CB69”,“name”: “verification_layer_page_2.xml”}},“data”: {“region”: “us”,“export_format”: “xls”,“verification_type”: “noverification”,“vendor_id”: “1”,“vendor_name”: “AA APPAREL”,“total”: “20208”,“currency”: “USD”},“is_moved”: false}],“is_extra_error”: false}
- ステータスがDoneに変わったら、識別子とトークン (前のステップのレスポンスに含まれるtargetファイル情報) を使用して出力ファイルをダウンロードできます。これには、File.Downloadメソッドを使用します。このrequestは、タスクrequest内の各入力ファイルに対して繰り返し実行できます。
リクエスト例
リクエスト例
curl -X GET —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l=” “https://api-eu.flexicapture.com/v2/file/5eeb7c1963ee5a1268123b96/A01EFC05BBB787DC6825F08E51B56CF3E066210E”
- 出力データをダウンロードしたら、すべての入力ファイルと出力ファイルを削除するためにタスクを削除します。これには、Task.Deleteメソッドを使用し、タスク識別子を指定します。
リクエスト例
リクエスト例
curl -X DELETE —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l=” “https://api-eu.flexicapture.com/v2/task/5eeb7bf728613d1e04a70782”
