API を利用するには、アカウントが必要です。まだ作成していない場合は、ABBYY FlexiCapture Cloud web portal から作成してください。
API へのすべてのリクエストには、認証ヘッダーを含める必要があります。認証ヘッダーを取得するには、次の手順に従います。
- application ID と token を、コロンを区切り文字として連結します (application ID と token は、ABBYY FlexiCapture Cloud web portal の Applications ページで確認できます) 。
- 生成された文字列を、いずれかの Base64 方式でエンコードします。
- ステップ 2 で得られた文字列の先頭に、認証方式とそれに続くスペースを追加します。
Application ID = Aladdin、token = OpenSesame
- application ID と token を連結します。
Aladdin:OpenSesame
- 文字列を、いずれかの Base64 方式でエンコードします。
QWxhZGRpbjpPcGVuU2VzYW1l
- ステップ 2 で得られた文字列の先頭に、認証方式とそれに続くスペースを追加します。
Basic QWxhZGRpbjpPcGVuU2VzYW1l
- 生成される認証ヘッダーは次のようになります。
Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l
サーバーにファイルをアップロードします。レスポンスでファイルの識別子とトークンが返されます。この識別子とトークンは、このファイルに関する以降のすべてのリクエストで使用されます。
curl -X POST —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l” “https://api-{location-id}.flexicapture.com/v2/file” —form “file=@/path/to/file/Letter.tif”
サポートされている location-id: us: USA とカナダ、au: オーストラリア、eu: 欧州連合加盟国。
REST API 経由でファイルをアップロードする場合、ドキュメントアセンブリのプロジェクト設定は無視されます。各ファイルごとに個別のドキュメントが作成されます。
ドキュメントのアップロード後、データ抽出を開始するにはタスクを開始します。このリクエストでは複数のファイルを指定できます。リクエストには、次のオプションのパラメーターを含めることができます: 請求書の地域、検証タイプ、および結果のエクスポート形式です。レスポンスにはタスク識別子が含まれます。
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”
サポートされているlocation-id: us: USA とカナダ、au: オーストラリア、eu: 欧州連合加盟国。
タスクの処理には時間がかかるため、抽出されたデータはすぐには利用できません。タスクの開始時に受け取った識別子を使用して、タスクのステータスを確認できます。ステータスが Done に変わるまで待ってください。
curl -X GET —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l” “https://api-{location-id}.flexicapture.com/v2/task/5ea18adc220e0d1c58177c59”
サポートされている location-id: us: USA とカナダ、au: オーストラリア、eu: 欧州連合加盟国。
タスクのステータスが Done に変わったら、識別子とトークンを使用して出力ファイルをダウンロードできます。このリクエストは、タスク要求内の各入力ファイルに対して繰り返し実行できます。
curl -X GET —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l=” “https://api-{location-id}.flexicapture.com/v2/file/5ea21f6b7a9ae6193831d671/D188E5EFC0042A83529899AC1E1D94400A25DCF6”
サポートされている location-id: us: USA とカナダ、au: オーストラリア、eu: 欧州連合加盟国。
出力データをダウンロードしたら、すべての入力ファイルと出力ファイルを削除するために、タスクを削除します。
curl -X DELETE —header “Accept: application/json” —header “Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l=” “https://api-{location-id}.flexicapture.com/v2/task/5ea18adc220e0d1c58177c59”
サポートされている location-id は次のとおりです。us: USA およびカナダ、au: オーストラリア、eu: 欧州連合加盟国。