メインコンテンツへスキップ
ABBYY FlexiCapture for Invoices Cloud API は、REST をベースに構成されています。この API を使用すると、ABBYY FlexiCapture Cloud サービスのリソースにアクセスできます。登録して認証ヘッダーを取得したら、ABBYY FlexiCapture for Invoices Cloud API にリクエストを送信できます。 この API は、HTTP 認証や HTTP メソッドなど、市販の HTTP クライアントでサポートされている標準的な HTTP 機能を使用します。 ABBYY FlexiCapture Cloud web portal には、Swagger 形式の API スキーマが含まれています。これを使用すると、Swagger Editor などの専用ツールを使って、プロジェクトで使用する言語のクライアントコードを生成できます。

​
API エンドポイント

https://api-{location-id}.flexicapture.com
{location-id} は、サポートされている次のいずれかのロケーションに置き換えます。
  • us: USA とカナダ
  • au: オーストラリア
  • eu: 欧州連合加盟国

​
REST リソース

以下のエンドポイント パスは、上記の API エンドポイントからの相対パスです。

​
v2.file

メソッドエンドポイント説明
アップロードPOST /v2/file1つ以上のファイルをクラウドにアップロードします。
ダウンロードGET /v2/file/{id}/{token}クラウドからファイルをダウンロードします。
取得GET /v2/file/{id}/{token}/infoファイルのメタデータを返します。
削除DELETE /v2/file/{id}/{token}クラウドからファイルを削除します。

​
v2.task

メソッドエンドポイント説明
RunPOST /v2/task/capture/invoices請求書取り込みタスクを実行します。
GetGET /v2/task/{id}タスクIDを指定してタスク情報を取得します。
DeleteDELETE /v2/task/{id}タスクIDを指定してタスクデータを削除します。

​
v2.dataset

メソッドエンドポイント説明
事業部門を作成POST /v2/dataset/businessunits事業部門のリストを作成します。
事業部門を更新PUT /v2/dataset/businessunitsデータセット内の事業部門の情報を更新します。
事業部門を取得GET /v2/dataset/businessunits/{region}指定した地域に対応する事業部門のリストを返します。
地域別に事業部門を削除DELETE /v2/dataset/businessunits/{region}指定した地域の事業部門をデータセットから削除します。
IDで事業部門を削除DELETE /v2/dataset/businessunit/{region}/{externalId}指定した外部 ID を持つ事業部門をデータセットから削除します。
ベンダーを作成POST /v2/dataset/vendorsベンダーのリストを作成します。
ベンダーを更新PUT /v2/dataset/vendorsデータセット内のベンダーの情報を更新します。
ベンダーを取得GET /v2/dataset/vendors/{region}指定した地域に対応するベンダーのリストを返します。
地域別にベンダーを削除DELETE /v2/dataset/vendors/{region}指定した地域のベンダーをデータセットから削除します。
IDでベンダーを削除DELETE /v2/dataset/vendor/{region}/{externalId}/{businessUnitId}指定した外部 ID を持つベンダーをデータセットから削除します。

​
v2.training

メソッドエンドポイント説明
学習POST /v2/trainingデータ抽出モデルを学習します。
LayoutGET /v2/training/layout/{taskId}/{fileId}抽出されたデータのレイアウトを取得します。