> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API リファレンス

> FlexiCapture for Invoices Cloud REST API のリファレンス: ファイル、タスク、事業部門およびベンダーのデータセット、学習に関するエンドポイントとリソース。

ABBYY FlexiCapture for Invoices Cloud API は、[REST](https://en.wikipedia.org/wiki/Representational_state_transfer) をベースに構成されています。この API を使用すると、ABBYY FlexiCapture Cloud サービスのリソースにアクセスできます。登録して認証ヘッダーを取得したら、ABBYY FlexiCapture for Invoices Cloud API にリクエストを送信できます。

この API は、HTTP 認証や HTTP メソッドなど、市販の HTTP クライアントでサポートされている標準的な HTTP 機能を使用します。

[ABBYY FlexiCapture Cloud web portal](https://flexicapture.com) には、Swagger 形式の API スキーマが含まれています。これを使用すると、[Swagger Editor](https://editor.swagger.io/) などの専用ツールを使って、プロジェクトで使用する言語のクライアントコードを生成できます。

<div id="api-endpoint">
  ## API エンドポイント
</div>

<a id="icaas-supported-countries" />

```text theme={null}
https://api-{location-id}.flexicapture.com
```

`{location-id}` は、サポートされている次のいずれかのロケーションに置き換えます。

* `us`: USA とカナダ
* `au`: オーストラリア
* `eu`: 欧州連合加盟国

<div id="rest-resources">
  ## REST リソース
</div>

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

<div id="v2file">
  ### v2.file
</div>

| メソッド                                                                      | エンドポイント                          | 説明                        |
| ------------------------------------------------------------------------- | -------------------------------- | ------------------------- |
| [アップロード](/ja/flexi-capture/cloud/cloud-f-cfor-invoices-api-upload-file)   | `POST /v2/file`                  | 1つ以上のファイルをクラウドにアップロードします。 |
| [ダウンロード](/ja/flexi-capture/cloud/cloud-f-cfor-invoices-api-download-file) | `GET /v2/file/{id}/{token}`      | クラウドからファイルをダウンロードします。     |
| [取得](/ja/flexi-capture/cloud/cloud-f-cfor-invoices-api-get-file-metadata) | `GET /v2/file/{id}/{token}/info` | ファイルのメタデータを返します。          |
| [削除](/ja/flexi-capture/cloud/cloud-f-cfor-invoices-api-delete-file)       | `DELETE /v2/file/{id}/{token}`   | クラウドからファイルを削除します。         |

<div id="v2task">
  ### v2.task
</div>

| メソッド                                                                    | エンドポイント                          | 説明                      |
| ----------------------------------------------------------------------- | -------------------------------- | ----------------------- |
| [Run](/ja/flexi-capture/cloud/cloud-f-cfor-invoices-api-run-task)       | `POST /v2/task/capture/invoices` | 請求書取り込みタスクを実行します。       |
| [Get](/ja/flexi-capture/cloud/cloud-f-cfor-invoices-api-get-task)       | `GET /v2/task/{id}`              | タスクIDを指定してタスク情報を取得します。  |
| [Delete](/ja/flexi-capture/cloud/cloud-f-cfor-invoices-api-delete-task) | `DELETE /v2/task/{id}`           | タスクIDを指定してタスクデータを削除します。 |

<div id="v2dataset">
  ### v2.dataset
</div>

| メソッド                                                                                  | エンドポイント                                                            | 説明                               |
| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | -------------------------------- |
| [事業部門を作成](/ja/flexi-capture/cloud/cloud-f-cfor-invoices-api-create-bu)                | `POST /v2/dataset/businessunits`                                   | 事業部門のリストを作成します。                  |
| [事業部門を更新](/ja/flexi-capture/cloud/cloud-f-cfor-invoices-api-update-bu)                | `PUT /v2/dataset/businessunits`                                    | データセット内の事業部門の情報を更新します。           |
| [事業部門を取得](/ja/flexi-capture/cloud/cloud-f-cfor-invoices-api-get-bu)                   | `GET /v2/dataset/businessunits/{region}`                           | 指定した地域に対応する事業部門のリストを返します。        |
| [地域別に事業部門を削除](/ja/flexi-capture/cloud/cloud-f-cfor-invoices-api-remove-b-uby-reg)     | `DELETE /v2/dataset/businessunits/{region}`                        | 指定した地域の事業部門をデータセットから削除します。       |
| [IDで事業部門を削除](/ja/flexi-capture/cloud/cloud-f-cfor-invoices-api-remove-b-uby-id)       | `DELETE /v2/dataset/businessunit/{region}/{externalId}`            | 指定した外部 ID を持つ事業部門をデータセットから削除します。 |
| [ベンダーを作成](/ja/flexi-capture/cloud/cloud-f-cfor-invoices-api-create-vendor)            | `POST /v2/dataset/vendors`                                         | ベンダーのリストを作成します。                  |
| [ベンダーを更新](/ja/flexi-capture/cloud/cloud-f-cfor-invoices-api-update-vendor)            | `PUT /v2/dataset/vendors`                                          | データセット内のベンダーの情報を更新します。           |
| [ベンダーを取得](/ja/flexi-capture/cloud/cloud-f-cfor-invoices-api-get-vendor)               | `GET /v2/dataset/vendors/{region}`                                 | 指定した地域に対応するベンダーのリストを返します。        |
| [地域別にベンダーを削除](/ja/flexi-capture/cloud/cloud-f-cfor-invoices-api-remove-vendor-by-reg) | `DELETE /v2/dataset/vendors/{region}`                              | 指定した地域のベンダーをデータセットから削除します。       |
| [IDでベンダーを削除](/ja/flexi-capture/cloud/cloud-f-cfor-invoices-api-remove-vendor-by-id)   | `DELETE /v2/dataset/vendor/{region}/{externalId}/{businessUnitId}` | 指定した外部 ID を持つベンダーをデータセットから削除します。 |

<div id="v2training">
  ### v2.training
</div>

| メソッド                                                                   | エンドポイント                                     | 説明                    |
| ---------------------------------------------------------------------- | ------------------------------------------- | --------------------- |
| [学習](/ja/flexi-capture/cloud/cloud-f-cfor-invoices-api-train-model)    | `POST /v2/training`                         | データ抽出モデルを学習します。       |
| [Layout](/ja/flexi-capture/cloud/cloud-f-cfor-invoices-api-get-layout) | `GET /v2/training/layout/{taskId}/{fileId}` | 抽出されたデータのレイアウトを取得します。 |