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

# フローAPI

> フローAPI を使用して、CData Arc のフローをクエリ可能なREST エンドポイントとして作成し公開する方法。

フローAPI を使用すると、モジュール式のシングルパスのArc フローを作成し、クエリ可能なエンドポイントとして公開できます。Arc は、フローAPI エンドポイントに渡したデータを処理し、結果をクエリサービスに返します。

フローAPI を使用して、外部アプリケーションやサービスからArc ワークフローを実行できます。この柔軟性により、お好みのツールを使用してワークフローと自動化を管理できます。

## ビデオリソース（英語）

フローAPI の設定方法と使い方は、こちらの動画をご覧ください。

[https://www.youtube.com/embed/Ed25uck0mwo](https://www.youtube.com/embed/Ed25uck0mwo)

## フローAPI の作成

フローAPI を作成するには、次の手順を実行してください：

1. フローキャンバスで、コネクタを右クリックして**API 設定を作成**を選択します。

   ![コネクタのコンテキストメニューのAPI 設定を作成オプション](https://mintcdn.com/cdata-arc/yfA3o6U6SThtnLN0/26.4/images/flow_api_create.png?fit=max\&auto=format\&n=yfA3o6U6SThtnLN0\&q=85\&s=fc5a213a4a3357030ae84b968325ea85)

   > [!NOTE]
   >
   > フローAPI は現在、特定のコネクタをサポートしていません。コネクタがサポートされていない場合、そのコネクタをフローAPI に追加しようとするとArc はエラーメッセージを表示します。フローAPI で使用できないコネクタのリストについては、[サポートされていないコネクタ](#サポートされていないコネクタ)を参照してください。

2. **API 設定を作成**ページが開きます。**メソッド**フィールドで、フローAPI がリクエストを受け付けるHTTP メソッドを選択します。オプションは、**GET**、**POST**、**PUT**、**PATCH**、および**DELETE** です。これは、フローAPI 作成後に必要に応じて変更できます。

   ![API 設定を作成ページ](https://mintcdn.com/cdata-arc/yfA3o6U6SThtnLN0/26.4/images/flow_api_createsettings_263.png?fit=max\&auto=format\&n=yfA3o6U6SThtnLN0\&q=85\&s=e010a1839d6786070ccc4687c5ab3a26)

3. **パス**フィールドで、フローAPI の名前を入力します。この名前は、API にクエリを発行するときに使用します。

   > [!NOTE]
   >
   > 異なる機能を実行する場合に限り、API 名を再利用できます。例えば、POST 機能を実行するAPI\_X12 というフローAPI とPATCH 機能を実行するAPI\_X12 というフローAPI を持つことはできますが、POST 機能を実行するAPI\_x12 というフローAPI を2つ持つことはできません。

4. **API を作成**をクリックします。**フローAPI 設定**が**設定**タブで開き、フローAPI がワークスペースに表示されます。

   ![ワークスペース内のフローAPI](https://mintcdn.com/cdata-arc/yfA3o6U6SThtnLN0/26.4/images/flow_api_workspace_263.png?fit=max\&auto=format\&n=yfA3o6U6SThtnLN0\&q=85\&s=385ec8c893e6af4bd351e06aa01aed88)

5. 追加のコネクタをフローAPI ボックスにドラッグし、それらを接続します。フローAPI ボックスにメモを追加することもできます。

> [!NOTE]
>
> フローAPI の最初のコネクタは、クエリを発行するエンティティからインプットデータを受信し、最後のコネクタは、クエリを発行するエンティティにアウトプットデータを送り返します。

コネクタの追加と接続が完了したら、フローAPI の設定とテストができます。

### 設定の構成

フローAPI のヘッダーにある歯車形の設定アイコンをクリックし、**設定**ペインを開きます。

![フローAPI の設定ペインを開く](https://mintcdn.com/cdata-arc/yfA3o6U6SThtnLN0/26.4/images/flow_api_opensettings.png?fit=max\&auto=format\&n=yfA3o6U6SThtnLN0\&q=85\&s=1c7f7c173ed50e18f5e0d815179a50d9)

このペインでは、フローAPI の動作を設定できます。

![フローAPI の設定ペイン](https://mintcdn.com/cdata-arc/yfA3o6U6SThtnLN0/26.4/images/flow_api_settings_263.png?fit=max\&auto=format\&n=yfA3o6U6SThtnLN0\&q=85\&s=100ecbf80f258261ab97b09c8335494c)

これらの設定については、以下のセクションで概要を説明します。

#### リクエスト

**パス**フィールドでは、フローAPI のリクエストの種類を選択します。リクエストの種類を変更する場合は、コネクタの構造と構成が新しいリクエストの種類に適していることを必ず確認してください。

フローAPI の任意の説明を入力するには、**説明**フィールドを使用します。これは、複数のフローAPI があり、それぞれの目的を追跡したい場合に便利です。

#### メタデータヘッダー

リクエストに含めたすべてのヘッダーは、メッセージがフローを通過する際に保持されます。これらのヘッダーには`API-Header-` プレフィックスが付くため、`MyHeader` というヘッダーは`API-Header-MyHeader` として表示されます。これらのヘッダーは、[アクティビティページ](https://docs.arc.cdata.com/26.4/self-hosted/ja/getting-started/administration/activity.md)でメッセージを展開したときに表示されます。コネクタの**トランザクション**タブでトランザクションを展開した場合も、ヘッダー情報を確認できます。

#### クエリパラメータ

このセクションでは、フローのクエリ文字列パラメータを指定できます。ここでパラメータを追加すると、メッセージがフローを通過するときにメタデータヘッダーとして保持されます。これらのヘッダーには`API-QueryParameter-` プレフィックスが付くため、`test` のクエリ文字列は`API-QueryParameter-test` になります。これらのヘッダーは、[メタデータヘッダー](#メタデータヘッダー)と同じ場所に表示されます。

この機能は、リクエストの一部として渡したい情報があるが、その情報がボディの一部ではない場合に便利です。例えば、データベース内の特定の会社の最新の注文Id が必要な場合は、CompanyName クエリパラメータをAPI に追加して、フロー内で`API-QueryParameter-CompanyName` ヘッダーを使用して参照することができます。

#### ボディとレスポンス

**ボディ**セクションでは、クエリを実行するクライアントがフローAPI と通信する方法に対応する**種類**を選択します：

* **None**—リクエストにボディを含まない
* **Raw**—任意の形式の自由形式データ
* **Form data**—name-value ペア
* **x-www-form-urlencoded**

**ボディ**および**レスポンス**のテキストフィールドでは、ドロップダウンメニューを使用して、ボディとレスポンスに期待するデータ形式（**XML**、**JSON**、または**Custom**）を選択します。

#### バイナリファイルの操作

フローAPI は、リクエストボディまたはレスポンスボディとして、バイナリファイル（PDF、JPEG、またはその他のバイナリファイル形式）のアップロードとダウンロードをサポートしています。テストペインを開くと（[フローAPI のテスト](#フローapi-のテスト)を参照）、フローAPI には次が含まれます：

* リクエストボディのコンテンツタイプがバイナリファイルの場合、次の画像に示すようにファイルアップロードボタンが表示されます

  ![テストペインのファイルアップロードボタン](https://mintcdn.com/cdata-arc/yfA3o6U6SThtnLN0/26.4/images/flow_api_upload_file.png?fit=max\&auto=format\&n=yfA3o6U6SThtnLN0\&q=85\&s=95f8661dfd607c6d8546803c6a372158)

* レスポンスのコンテンツタイプがバイナリファイルの場合、ファイルダウンロードボタンが表示されます

> [!NOTE]
>
> API がバイナリファイルの代わりにBase64 エンコードされたテキストを返す必要がある場合は、[Script](https://docs.arc.cdata.com/26.4/self-hosted/ja/connectors/script.md) コネクタを使用して出力をBase64 としてエンコードし、レスポンスのコンテンツタイプを`text/plain` などに設定する必要があります。

### 呼び出しアクセスユーザー

フローAPI を呼び出すことができるユーザーの一覧を確認するには、**設定**ペインを開いて**呼び出しアクセスユーザー**をクリックします。このタブには、割り当てられた[ポリシー](https://docs.arc.cdata.com/26.4/self-hosted/ja/getting-started/administration/settings/user-roles.md#ロールとポリシーの作成)に基づいてフローAPI を呼び出すことができるすべてのStandard ユーザーとService ユーザーの一覧が表示されます。**ユーザーを追加**をクリックして、フローAPI を呼び出すことができる他のユーザーにアクセス権を付与します。

![フローAPI を呼び出すことができるすべてのユーザーの一覧](https://mintcdn.com/cdata-arc/yfA3o6U6SThtnLN0/26.4/images/flow_api_invoke_access_users.png?fit=max\&auto=format\&n=yfA3o6U6SThtnLN0\&q=85\&s=c4d2937674ac97c184b6c76387040e6c)

### サポートされていないコネクタ

フローAPI のコネクタは、インプットメッセージごとに1つのアウトプットメッセージが生成されるように接続する必要があります。スケジュールまたは外部プロセスに基づいてファイルを処理するコネクタはサポートされていません。そのため、次のコネクタはフローAPI では使用できません：

* [API](https://docs.arc.cdata.com/26.4/self-hosted/ja/connectors/api/api.md)
* [Copy](https://docs.arc.cdata.com/26.4/self-hosted/ja/connectors/copy.md)
* [Email Receive](https://docs.arc.cdata.com/26.4/self-hosted/ja/connectors/email-receive.md)
* [Form](https://docs.arc.cdata.com/26.4/self-hosted/ja/connectors/form.md)
* [FTP Server](https://docs.arc.cdata.com/26.4/self-hosted/ja/connectors/ftp-server.md)
* [RSS](https://docs.arc.cdata.com/26.4/self-hosted/ja/connectors/rss.md)
* [Schedule](https://docs.arc.cdata.com/26.4/self-hosted/ja/connectors/schedule.md)
* [SFTP Server](https://docs.arc.cdata.com/26.4/self-hosted/ja/connectors/sftp-server.md)
* [Webhook](https://docs.arc.cdata.com/26.4/self-hosted/ja/connectors/webhook.md)
* [Workspace Receive](https://docs.arc.cdata.com/26.4/self-hosted/ja/connectors/workspace-receive.md)

### フローAPI の例

以下の例は、POST で構成されたフローAPI の実際の使用例を示しています：

![ワークスペース内のフローAPI の例](https://mintcdn.com/cdata-arc/yfA3o6U6SThtnLN0/26.4/images/flow_api_example_263.png?fit=max\&auto=format\&n=yfA3o6U6SThtnLN0\&q=85\&s=3f4aa03f9e40bdf13fc2bc811308edf1)

このフローAPI は、以下のワークフローを実行します：

1. データは、開始ノードで、暗号化されたX12 ファイルの形式で受信されます。

2. OpenPGP\_Decrypt コネクタは、X12 ファイルを復号化してX12 コネクタに渡します。

3. X12 コネクタは、X12 ファイルをXML に変換し、変換したXML ファイルをJSON コネクタに渡します。

4. JSON コネクタは、XML ファイルをJSON 形式に変換し、変換したファイルをOpenPGP\_Encrypt コネクタに渡します。OpenPGP\_Encrypt コネクタは、JSON ファイルを暗号化します。

5. 暗号化されたJSON ファイルは、終了ノードを通じて返されます。

この例では、各コネクタは前後2つの別のコネクタにリンクされています。開始ノードと終了ノードは、フローのエンドポイントに自動的に追加されます。

## フローAPI のテスト

フローAPI を作成したら、サンプルリクエストを実行して構成をテストできます。

フローAPI のテストペインを開くには、フローAPI のヘッダーにある三角形のアイコンをクリックします。

![フローAPI のテストペインを開く](https://mintcdn.com/cdata-arc/yfA3o6U6SThtnLN0/26.4/images/flow_api_opentest.png?fit=max\&auto=format\&n=yfA3o6U6SThtnLN0\&q=85\&s=eeb88559edc4c9f9809d49d8c2261ea4)

テストペインでは、左側のボックスがリクエストとして機能し、右側のボックスにレスポンスが表示されます。各ボックスには、設定ペインで選択された期待するデータ形式が表示されます。

![フローAPI のテストペイン](https://mintcdn.com/cdata-arc/yfA3o6U6SThtnLN0/26.4/images/flow_api_test_263.png?fit=max\&auto=format\&n=yfA3o6U6SThtnLN0\&q=85\&s=7691d9c31b57fba749b56d0f689e760a)

フローAPI をテストするには、左側のボックスにテストクエリを入力して**実行**をクリックします。レスポンスが期待する結果と一致したら、フローAPI は使用できる状態になります。レスポンスが正しくない場合は、フローAPI の構成とフローAPI 内の各コネクタの設定を確認してください。

## 外部アプリケーションでのフローAPI の使用

以下の手順は、外部クライアントからフローAPI を呼び出す方法について説明します。この例では、Postman からフローAPI を実行する方法を示していますが、REST リクエストを送信できる任意のクライアントであれば使用できます。

1. フローデザイナーの右下にある**複数コネクタを選択**オプションを使用して、API として公開するフローを選択します。次に**API 設定を作成**をクリックします。このアクションにより、**API 設定を作成**ダイアログが開きます。

2. 以下のように、メソッド（例えば、**POST**）を選択してAPI に意味のある名前を付けます。

   ![API 設定を作成でメソッドを選択する](https://mintcdn.com/cdata-arc/pXe_oAwLTI7MI6MK/26.4/images/arc_flow_method.png?fit=max\&auto=format\&n=pXe_oAwLTI7MI6MK\&q=85\&s=97342be23558f2fddc588c0db115b2c0)

3. **API を作成**をクリックし、フローAPI を作成します。

4. **設定**ペインで、フローAPI を構成して、**ボディ**セクションの期待する<var>Content-Type</var> 値と**レスポンス**セクションのレスポンスに必要な<var>Content-Type</var> 値を定義します。オプションとして、リクエストとレスポンスのサンプルデータを提供できます。

5. **リクエスト**ペインに表示されるパスをコピーします。

6. Postman アプリケーションを開きます。<var>Content-Type</var> ドロップダウンリストに同じコンテンツタイプ（この場合は**POST**）が表示されていることを確認します。Arc (手順5) でコピーしたパスを、リクエストURL フィールドにペーストします。リクエストのボディをフローを開始するコンテンツとして指定します。

   ![Postman でContent-Type パスをコピー＆ペーストする](https://mintcdn.com/cdata-arc/pXe_oAwLTI7MI6MK/26.4/images/arc_body_content.png?fit=max\&auto=format\&n=pXe_oAwLTI7MI6MK\&q=85\&s=10cbb6aa77d0242d127f60c99f43b835)

7. フローAPI を認証します。フローAPI は、管理API と同じ認証ルールを使用します。この例では、認証方式として認証トークンヘッダー（**x-cdata-authtoken**）を使用します。

   この方式を使用するには：

   1. ナビゲーションバーの**設定**歯車アイコンをクリックします。次に、**追加**をクリックして**ユーザーを追加**ダイアログを開くか、既存のユーザーを編集します。

   2. ダイアログが表示されたら、**API 接続**チェックボックスを選択して認証トークンを表示します。（ダイアログは再度表示されないので、このトークンを安全な場所に控えておいてください。認証トークンを紛失または削除した場合は、新しい認証トークンを作成する必要があります。）次に、**変更を保存**をクリックします。

   3. Postman アプリケーションに戻り、フローAPI の認証情報を以下のように追加します：

      1. **Headers** タブをクリックします。

      2. **Key** フィールドに、**x-cdata-authtoken** をペーストします。

      3. **Value** フィールドに、Arc でコピーした認証トークンをペーストします。

8. リクエストの準備が整ったら**Send** ボタンをクリックします。以下の例に示すように、送信したリクエストに対するレスポンスが表示されます：

   ![Postman でのリクエストに対するレスポンス](https://mintcdn.com/cdata-arc/pXe_oAwLTI7MI6MK/26.4/images/arc_response_to_request.png?fit=max\&auto=format\&n=pXe_oAwLTI7MI6MK\&q=85\&s=716fc546cc6926d8f285f44e556e898d)

### クロスオリジンリソース共有（CORS）

[セキュリティタブ](https://docs.arc.cdata.com/26.4/self-hosted/ja/getting-started/administration/settings/security.md)の[管理API](../admin-api) セクションに移動すると、フローAPI のクロスオリジンリソース共有（CORS）を設定できます。CORS によって、ブラウザベースのクライアントからArc に接続することができます。CORS ができない場合、ブラウザにより同一オリジンポリシーが強制されるため、ブラウザベースのスクリプトはArc に接続できません。このポリシーは、クライアントサイドスクリプトおよびドキュメントが、自身のオリジン以外のリソースをロードすることを制限します。スクリプトのオリジンは、プロトコル、ホスト、およびポートから成ります。

<table><thead><tr><th>設定</th><th>説明</th></tr></thead>
<tbody><tr><td>**Enable cross-origin resource sharing (CORS)**</td>
<td>CORS を有効にするかどうか。このチェックボックスをオンにした場合にのみ、その他のオプションが利用可能になります。</td></tr>
<tr><td>**Allow all domains without '\*'**</td>
<td>有効にすると、ドメインオリジンは特定のリストに制限されません。</td></tr>
<tr><td>**Access-Control-Allow-Origin**</td>
<td>許可するドメインオリジンのカンマ区切りのリスト。HTTP レスポンスヘッダーとして含まれます。</td></tr>
<tr><td>**Access-Control-Allow-Credentials**</td>
<td>Cookie などのユーザー認証情報をクロスオリジンリクエストで許可するかどうか。HTTP レスポンスヘッダーとして含まれます。</td></tr>
<tr><td>**Access-Control-Allow-Methods**</td>
<td>許可するメソッドのカンマ区切りのリスト。HTTP レスポンスヘッダーとして含まれます。</td></tr>
<tr><td>**Access-Control-Allow-Headers**</td>
<td>許可するヘッダーのカンマ区切りのリスト。HTTP レスポンスヘッダーとして含まれます。</td></tr>
<tr><td>**Access-Control-Max-Age**</td>
<td>Access-Control レスポンスヘッダーの値をキャッシュできる最大時間（秒単位）。</td></tr></tbody></table>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.