カスタムAPIアクションカードの構築
Custom API Action(カスタムAPIアクション、CAPIA)は、エンドユーザーが対象サービスへの認証済みHTTPリクエストを作成できる、コネクターで利用できるアクションカードです。ベースURLはコネクターにハードコーディングされるため、エンドユーザーは相対URLを追加するだけです。その上で、必要に応じてヘッダー、クエリ、リクエスト本文のヘッダーに必要なオブジェクトを手動で作成します。CAPIAは、サービスからのデータをStatus Code(ステータスコード)、Headers(ヘッダー)、Body(本文)の3つの出力として返します。
-
ページ右上端の[+ New Flow(新規フロー)]をクリックし、[Flows(フロー)]タブで新規フローを作成します。
-
ページの左端にある[Action(アクション)]ボタンをクリックします。
-
ツールバーの[Save(保存)]ボタンをクリックし、フローに
Custom API Action
という名前を付けます。 -
フローの説明フィールドに「
Make an authenticated HTTP request to the {your service} API({サービス名} APIへの認証済みHTTPリクエストの作成)
」と入力し、[Save all data that passes through the Flow(フローを通過するすべてのデータを保存)]ボックスをチェックして[Save(保存)]をクリックします。 -
Connector Actionカードの[Add Options(オプションの追加)]ボタンをクリックします。
-
[Add Field(フィールドの追加)]ボタンをクリックし、
Request Type(リクエストタイプ)
というラベルのフィールドを追加して「Dropdown: Static Values(ドロップダウン:静的な値)」と入力します。 -
[Add Option(オプションの追加)]ボタンをクリックし、ユーザーがAPI向けに選択できる各リクエストタイプ(GET、PATCH、POST、PUT、DELETE)の行を追加します。[Option(オプション)]と[Value(値)]の両方のフィールドに同じテキストを入力する必要があります。[Default(デフォルト)]を選択する必要はありません。
-
フィールドにRequired(必須)のマークが付けられていることを確認し、[Save(保存)]をクリックします。
-
Connector Actionカードの[Add Inputs(入力の追加)]ボタンをクリックします。
-
[Add Field(フィールドの追加)]ボタンをクリックし、次のフィールドとデータタイプを追加して[Save(保存)]をクリックします。
-
Relative URL(テキスト)(必須)
-
Query(オブジェクト)
-
Headers(オブジェクト)
-
Body(オブジェクト)
-
Flow Control Call Flowカードをフローの最初のカードとして追加します。
-
[Choose Flow(フローの選択)]ボタンをクリックします。
-
事前に作成したhttpHelperフローを選択します。カードには、httpHelperフローに定義されている入力が自動的に取り込まれます。
-
Connector ActionカードのRelative URL出力をCall Flowカードのrelative_url入力にドラッグします。
-
Connector ActionカードのRequest Type出力をCall Flowカードのrequest_method入力にドラッグします。
-
Connector ActionカードのQuery出力をCall Flowカードのquery入力にドラッグします。
-
Connector ActionカードのHeaders出力をCall Flowカードのheaders入力にドラッグします。
-
Connector ActionカードのBody出力をCall Flowカードのbody入力にドラッグします。
-
Flow Control Call Flowカードの出力には、httpHelperフローの出力と同じキーを定義する必要があります。
-
status_code(数値)
-
headers(オブジェクト)
-
body(オブジェクト)
- Return Outputsカードの[Add Outputs(オプションの追加)]ボタンをクリックします。
- [Add Field(フィールドの追加)]ボタンをクリックし、次の3つの新規フィールドとデータタイプを追加して[Save(保存)]をクリックします。
-
Status Code(数値)
-
Headers(オブジェクト)
-
Body(オブジェクト)
-
Call Flowの出力をReturn Outputsカードの対応する入力にドラッグします。
-
Connector AuthpingカードのauthオブジェクトをCall FlowカードのConnection入力フィールドにドラッグします。
-
フローを保存し、テストダイアログにrequest_method、相対URL、その他の必要データを手動で追加してテストします。