API による請求書の処理

このガイドでは、ABBYY FlexiCapture for Invoices Cloud API を使用して初めての請求書を処理する方法を説明します。認証ヘッダーを作成し、ファイルをアップロードし、タスクを開始して、結果をダウンロードします。すべてのエンドポイントで、ベース URL https://api-{location-id}.flexicapture.com を使用します。ここで、{location-id} はサポートされているロケーションを表し、us (USA とカナダ) 、au (オーストラリア) 、または eu (欧州連合加盟国) のいずれかです。

アカウントを作成

API を利用するには、アカウントが必要です。まだ作成していない場合は、ABBYY FlexiCapture Cloud web portal で作成してください。

Authorization ヘッダーを取得する

API へのすべてのリクエストには、application ID とトークンから作成した authorization header を含める必要があります。手順については、Authenticationを参照してください。以下の例では、サンプルヘッダー Basic QWxhZGRpbjpPcGVuU2VzYW1l を使用しています。

ファイルをアップロード

ファイルをサーバーにアップロードします。レスポンスでファイルの識別子とトークンを取得できます。これらは、このファイルに関する以降のすべてのリクエストで使用されます。

curl -X POST \
  --header "Accept: application/json" \
  --header "Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l" \
  --form "file=@/path/to/file/Letter.tif" \
  "https://api-{location-id}.flexicapture.com/v2/file"

REST API 経由でファイルをアップロードする場合、document assembly のプロジェクト設定は適用されません。各ファイルが個別のドキュメントとして作成されます。

タスクを開始する

ドキュメントがアップロードされたら、タスクを開始してデータ抽出を始めます。このリクエストでは複数のファイルを指定できます。リクエストには、次のオプションのパラメーターを含めることができます: 請求書の地域、検証タイプ、結果のエクスポート形式。レスポンスにはタスク識別子が含まれます。

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": "5ea16ff21b777315586713bf",
        "token": "34FB84AA68684F0F2BF496045224EB6C436F596B"
      }
    ]
  }' \
  "https://api-{location-id}.flexicapture.com/v2/task/capture/invoices"

タスクのステータスを取得する

タスクの処理には多少時間がかかるため、抽出されたデータをすぐに利用することはできません。タスクの開始時に受け取った識別子を使用して、タスクのステータスを確認できます。ステータスがDoneに変わるまでお待ちください。

curl -X GET \
  --header "Accept: application/json" \
  --header "Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l" \
  "https://api-{location-id}.flexicapture.com/v2/task/5ea18adc220e0d1c58177c59"

結果をダウンロードする

タスクのステータスがDoneに変わったら、識別子とトークンを使用して出力ファイルをダウンロードできます。タスク要求内の各入力ファイルに対して、このリクエストを繰り返してください。

curl -X GET \
  --header "Accept: application/json" \
  --header "Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l" \
  "https://api-{location-id}.flexicapture.com/v2/file/5ea21f6b7a9ae6193831d671/D188E5EFC0042A83529899AC1E1D94400A25DCF6"

タスクを削除

出力データをダウンロードした後、すべての入力ファイルと出力ファイルを削除するには、タスクを削除します。

curl -X DELETE \
  --header "Accept: application/json" \
  --header "Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l" \
  "https://api-{location-id}.flexicapture.com/v2/task/5ea18adc220e0d1c58177c59"

Administrator's Guide

Administration Guide

Performance Guide

Troubleshooting

Cloud