Skip to main content
フローAPI を使用すると、モジュール式のシングルパスの フローを作成し、クエリ可能なエンドポイントとして公開できます。 は、フローAPI エンドポイントに渡したデータを処理し、結果をクエリサービスに返します。 フローAPI を使用して、外部アプリケーションやサービスから ワークフローを実行できます。この柔軟性により、お好みのツールを使用してワークフローと自動化を管理できます。

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

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

​
フローAPI の作成

フローAPI を作成するには、次の手順を実行してください：
  1. フローキャンバスで、コネクタを右クリックしてAPI 設定を作成を選択します。 コネクタのコンテキストメニューのAPI 設定を作成オプション
    フローAPI は現在、特定のコネクタをサポートしていません。コネクタがサポートされていない場合、そのコネクタをフローAPI に追加しようとすると はエラーメッセージを表示します。フローAPI で使用できないコネクタのリストについては、サポートされていないコネクタを参照してください。
  2. API 設定を作成ページが開きます。メソッドフィールドで、フローAPI がリクエストを受け付けるHTTP メソッドを選択します。オプションは、GET、POST、PUT、PATCH、およびDELETE です。これは、フローAPI 作成後に必要に応じて変更できます。 API 設定を作成ページ
  3. パスフィールドで、フローAPI の名前を入力します。この名前は、API にクエリを発行するときに使用します。
    異なる機能を実行する場合に限り、API 名を再利用できます。例えば、POST 機能を実行するAPI_X12 というフローAPI とPATCH 機能を実行するAPI_X12 というフローAPI を持つことはできますが、POST 機能を実行するAPI_x12 というフローAPI を2つ持つことはできません。
  4. API を作成をクリックします。フローAPI 設定が設定タブで開き、フローAPI がワークスペースに表示されます。 ワークスペース内のフローAPI
  5. 追加のコネクタをフローAPI ボックスにドラッグし、それらを接続します。フローAPI ボックスにメモを追加することもできます。
フローAPI の最初のコネクタは、クエリを発行するエンティティからインプットデータを受信し、最後のコネクタは、クエリを発行するエンティティにアウトプットデータを送り返します。
コネクタの追加と接続が完了したら、フローAPI の設定とテストができます。

​
設定の構成

フローAPI のヘッダーにある歯車形の設定アイコンをクリックし、設定ペインを開きます。 フローAPI の設定ペインを開く このペインでは、フローAPI の動作を設定できます。 フローAPI の設定ペイン これらの設定については、以下のセクションで概要を説明します。

​
リクエスト

パスフィールドでは、フローAPI のリクエストの種類を選択します。リクエストの種類を変更する場合は、コネクタの構造と構成が新しいリクエストの種類に適していることを必ず確認してください。 フローAPI の任意の説明を入力するには、説明フィールドを使用します。これは、複数のフローAPI があり、それぞれの目的を追跡したい場合に便利です。

​
メタデータヘッダー

リクエストに含めたすべてのヘッダーは、メッセージがフローを通過する際に保持されます。これらのヘッダーにはAPI-Header- プレフィックスが付くため、MyHeader というヘッダーはAPI-Header-MyHeader として表示されます。これらのヘッダーは、アクティビティページでメッセージやトランザクションを展開したとき、またはメッセージの詳細を表示したときに表示されます。コネクタのトランザクションタブでトランザクションを展開した場合も、ヘッダー情報を確認できます。

​
クエリパラメータ

このセクションでは、フローのクエリ文字列パラメータを指定できます。ここでパラメータを追加すると、メッセージがフローを通過するときにメタデータヘッダーとして保持されます。これらのヘッダーには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 がバイナリファイルの代わりにBase64 エンコードされたテキストを返す必要がある場合は、Script コネクタを使用して出力をBase64 としてエンコードし、レスポンスのコンテンツタイプをtext/plain などに設定する必要があります。

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

フローAPI を呼び出すことができるユーザーの一覧を確認するには、設定ペインを開いて呼び出しアクセスユーザーをクリックします。このタブには、割り当てられたポリシーに基づいてフローAPI を呼び出すことができるすべてのStandard ユーザーとService ユーザーの一覧が表示されます。ユーザーを追加をクリックして、フローAPI を呼び出すことができる他のユーザーにアクセス権を付与します。 フローAPI を呼び出すことができるすべてのユーザーの一覧

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

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

​
フローAPI の例

以下の例は、POST で構成されたフローAPI の実際の使用例を示しています： ワークスペース内のフローAPI の例 このフロー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 のテストペインを開く テストペインでは、左側のボックスがリクエストとして機能し、右側のボックスにレスポンスが表示されます。各ボックスには、設定ペインで選択された期待するデータ形式が表示されます。 フローAPI のテストペイン フローAPI をテストするには、左側のボックスにテストクエリを入力して実行をクリックします。レスポンスが期待する結果と一致したら、フローAPI は使用できる状態になります。レスポンスが正しくない場合は、フローAPI の構成とフローAPI 内の各コネクタの設定を確認してください。

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

以下の手順は、外部クライアントからフローAPI を呼び出す方法について説明します。この例では、Postman からフローAPI を実行する方法を示していますが、REST リクエストを送信できる任意のクライアントであれば使用できます。
  1. フローデザイナーの右下にある複数コネクタを選択オプションを使用して、API として公開するフローを選択します。次にAPI 設定を作成をクリックします。このアクションにより、API 設定を作成ダイアログが開きます。
  2. 以下のように、メソッド（例えば、POST）を選択してAPI に意味のある名前を付けます。 API 設定を作成でメソッドを選択する
  3. API を作成をクリックし、フローAPI を作成します。
  4. 設定ペインで、フローAPI を構成して、ボディセクションの期待するContent-Type 値とレスポンスセクションのレスポンスに必要なContent-Type 値を定義します。オプションとして、リクエストとレスポンスのサンプルデータを提供できます。
  5. リクエストペインに表示されるパスをコピーします。
  6. Postman アプリケーションを開きます。Content-Type ドロップダウンリストに同じコンテンツタイプ（この場合はPOST）が表示されていることを確認します。 (手順5) でコピーしたパスを、リクエストURL フィールドにペーストします。リクエストのボディをフローを開始するコンテンツとして指定します。 Postman でContent-Type パスをコピー＆ペーストする
  7. フローAPI を認証します。フローAPI は、管理API と同じ認証ルールを使用します。この例では、認証方式として認証トークンヘッダー（x-cdata-authtoken）を使用します。 この方式を使用するには：
    1. ナビゲーションバーの設定歯車アイコンをクリックします。次に、追加をクリックしてユーザーを追加ダイアログを開くか、既存のユーザーを編集します。
    2. ダイアログが表示されたら、API 接続チェックボックスを選択して認証トークンを表示します。（ダイアログは再度表示されないので、このトークンを安全な場所に控えておいてください。認証トークンを紛失または削除した場合は、新しい認証トークンを作成する必要があります。）次に、変更を保存をクリックします。
    3. Postman アプリケーションに戻り、フローAPI の認証情報を以下のように追加します：
      1. Headers タブをクリックします。
      2. Key フィールドに、x-cdata-authtoken をペーストします。
      3. Value フィールドに、 でコピーした認証トークンをペーストします。
  8. リクエストの準備が整ったらSend ボタンをクリックします。以下の例に示すように、送信したリクエストに対するレスポンスが表示されます： Postman でのリクエストに対するレスポンス

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

セキュリティタブの管理API セクションに移動すると、フローAPI のクロスオリジンリソース共有（CORS）を設定できます。CORS によって、ブラウザベースのクライアントから に接続することができます。CORS ができない場合、ブラウザにより同一オリジンポリシーが強制されるため、ブラウザベースのスクリプトは に接続できません。このポリシーは、クライアントサイドスクリプトおよびドキュメントが、自身のオリジン以外のリソースをロードすることを制限します。スクリプトのオリジンは、プロトコル、ホスト、およびポートから成ります。