HTTPアクション

概要

HTTP コネクタは任意のエンドポイントに対して HTTP リクエストを送信できるコネクタです。Anyflow Embed がコネクタとして提供していない外部ツールの API を利用します。

HTTP コネクタは、Anyflow Embed のほとんどのコネクタのサポートでサポートされているカスタムアクションを、特定のコネクタに縛られることなく、柔軟に利用できるようにしたものになります。

カスタムアクションのドキュメントも必要に応じて参照ください。

---

HTTP コネクタで利用可能なアクション

HTTP コネクタでは、現在以下のアクションを利用可能です。

• リクエストを送信

  • HTTP リクエストで独自のアクションを構築します。

---

「リクエストを送信」アクションの入力フィールド

カスタムアクションの設定入力フィールドの詳細について説明します。

入力フィールド	説明
表示名	作成するアクションに名前をつけます。
HTTPメソッド	呼び出す API エンドポイントの HTTP メソッドです。
リクエストURI	呼び出す API エンドポイントの URI です。
リクエストURLパラメーター	URL パラメーターを渡すことが可能です。
リクエストヘッダー	HTTP リクエストヘッダーを指定。
レスポンスヘッダー定義	API が返すと期待される HTTP レスポンスヘッダーを Anyflow Embed に説明します。これは出力値のデータツリーを生成するために使用します。
レスポンスタイプ	API が返すと期待される出力スキーマを Anyflow Embed に説明します。これは、出力値のデータツリーを生成するために使用します。
レスポンスボディ定義	API が返すレスポンスをソリューション内で利用したいフィールドを定義します。

レスポンスタイプの違い

• json：多くの場合はこちらを選択します。レスポンスはAnyflowによりツリー構造として解釈され、ソリューション内で利用できます。

• raw：レスポンスとしてファイルが返却されるAPIなどで、レスポンスがツリー構造ではない場合やAnyflowとしての解釈が不要な場合はこちらを選択します。デフォルトでは、rawのレスポンスは文字列型の変数に格納されます。

📘ヒント

rawのレスポンス実態が文字列ではない場合、は変数アクションを使って適切な型の変数を作成し、そこにrawのレスポンスを格納することで、ソリューション内で正しく扱うことができます。

ヒント

rawのレスポンス実態が文字列ではない場合、は変数アクションを使って適切な型の変数を作成し、そこにrawのレスポンスを格納することで、ソリューション内で正しく扱うことができます。

例：rawの実態がFile型なので、File型の変数に格納する

---

利用例

Slack チャンネルのメンバー情報一覧を取得する「リクエストを送信」アクション例

Slack チャンネルに参加しているメンバーの一覧を取得する「リクエストを送信」アクションを構築してみましょう。

ヒント

この例では独自のSlackBotを作成したうえで、そのBotのTokenを使ってAPIを呼び出します。 独自のSlackBotを用意されていない方はこちらを参照してください。

選択したアクションに名前を付けます。 今回は「メンバー一覧取得」というカスタムアクション名を入力します。 この名前は、アクション名の下部分に表示されます。

呼び出す API のエンドポイントに基づいて、リクエストの HTTP メソッドを選択します。 Slack API のドキュメントを確認すると、HTTP メソッドが記載されています。 今回の場合、conversations.membersがGET メソッドを使用することを示しています。

Slack APIドキュメント:conversations.members

HTTP メソッドを選択すると、アクションに関連する入力フィールドが表示されます。

リクエスト URI にはhttps://slack.com/api/conversations.membersと入力します。

conversations.members の URL エンドポイントを追加します

送信するリクエストを定義します。 この API エンドポイントでは、tokenの他にchannelをパラメーターとして渡す必要があります。

Slack APIドキュメント:conversations.membersのArguments

リクエスト URL パラメーターを設定します。

キーと値を入力します。

リクエストヘッダーに Slack Botの認証トークンを設定します。

Slack Bot の認証トークンはSlackBotのOAuth Tokensの項目から取得できます。

取得したトークンをヘッダーに設定します。

キーと値を入力します。

レスポンスタイプを選択します。 選択後、レスポンスボディを定義する入力フィールドが表示されます。

レスポンスタイプを選択すると、入力フィールドが表示されます。

レスポンスボディを定義します。 まず、 Slack API のドキュメントにて、どんなレスポンス構造になっているかを確認します。

Slack APIドキュメント:conversations.membersのExample responses

次に、Common successful response のJSON をコピーし、Anyflow Embed で「JSONで追加」を選択します。

「JSONで追加」のモーダル

「JSONで追加」を行った後の状態

定義する項目について

後続の処理の中で使用したい項目のみを定義します。 ドキュメントに明記されている項目を全て定義する必要はありません。 ここで定義した項目は、後続の処理で利用可能です。

これでHTTP コネクタの「リクエストを送信」アクションが完成したので、テスト実行をしてみましょう。 トリガーなしでアクションを迅速にテストしたい場合は、Click トリガーを使用してテストします。

上記アクションをテスト実行した際、アクションに渡された入力をテスト履歴から確認可能です。

テスト履歴: 入力値

また、Slack APIから返された詳細な出力値を確認し、APIコールが成功したかがどうか確認可能です。

テスト履歴: 出力値

こちらの呼び出しは成功したようです。