カスタムAPIアクションカードの構築

Custom API Action（カスタムAPIアクション、CAPIA）は、エンドユーザーが対象サービスへの認証済みHTTPリクエストを作成できる、コネクターで利用できるアクションカードです。ベースURLはコネクターにハードコーディングされるため、エンドユーザーは相対URLを追加するだけです。その上で、必要に応じてヘッダー、クエリ、リクエスト本文のヘッダーに必要なオブジェクトを手動で作成します。CAPIAは、サービスからのデータをStatus Code（ステータスコード）、Headers（ヘッダー）、Body（本文）の3つの出力として返します。

  1. ページ右上端の［+ New Flow（新規フロー）］をクリックし、［Flows（フロー）］タブで新規フローを作成します。

  2. ページの左端にある［Action（アクション）］ボタンをクリックします。

  3. ツールバーの［Save（保存）］ボタンをクリックし、フローにCustom API Actionという名前を付けます。

  4. フローの説明フィールドに「Make an authenticated HTTP request to the {your service} API（{サービス名} APIへの認証済みHTTPリクエストの作成）」と入力し、［Save all data that passes through the Flow（フローを通過するすべてのデータを保存）］ボックスをチェックして［Save（保存）］をクリックします。

  5. Connector Actionカードの［Add Options（オプションの追加）］ボタンをクリックします。

  6. ［Add Field（フィールドの追加）］ボタンをクリックし、Request Type（リクエストタイプ）というラベルのフィールドを追加して「Dropdown: Static Values（ドロップダウン：静的な値）」と入力します。

  7. ［Add Option（オプションの追加）］ボタンをクリックし、ユーザーがAPI向けに選択できる各リクエストタイプ（GET、PATCH、POST、PUT、DELETE）の行を追加します。［Option（オプション）］と［Value（値）］の両方のフィールドに同じテキストを入力する必要があります。［Default（デフォルト）］を選択する必要はありません。

  8. フィールドにRequired（必須）のマークが付けられていることを確認し、［Save（保存）］をクリックします。

  9. Connector Actionカードの［Add Inputs（入力の追加）］ボタンをクリックします。

  10. ［Add Field（フィールドの追加）］ボタンをクリックし、次のフィールドとデータタイプを追加して［Save（保存）］をクリックします。

  • Relative URL（テキスト）（必須）

  • Query（オブジェクト）

  • Headers（オブジェクト）

  • Body（オブジェクト）

  1. Flow Control Call Flowカードをフローの最初のカードとして追加します。

  2. ［Choose Flow（フローの選択）］ボタンをクリックします。

  3. 事前に作成したhttpHelperフローを選択します。カードには、httpHelperフローに定義されている入力が自動的に取り込まれます。

  4. Connector ActionカードのRelative URL出力をCall Flowカードのrelative_url入力にドラッグします。

  5. Connector ActionカードのRequest Type出力をCall Flowカードのrequest_method入力にドラッグします。

  6. Connector ActionカードのQuery出力をCall Flowカードのquery入力にドラッグします。

  7. Connector ActionカードのHeaders出力をCall Flowカードのheaders入力にドラッグします。

  8. Connector ActionカードのBody出力をCall Flowカードのbody入力にドラッグします。

  9. Flow Control Call Flowカードの出力には、httpHelperフローの出力と同じキーを定義する必要があります。

  • status_code（数値）

  • headers（オブジェクト）

  • body（オブジェクト）

  1. Return Outputsカードの［Add Outputs（オプションの追加）］ボタンをクリックします。
  2. ［Add Field（フィールドの追加）］ボタンをクリックし、次の3つの新規フィールドとデータタイプを追加して［Save（保存）］をクリックします。

  • Status Code（数値）

  • Headers（オブジェクト）

  • Body（オブジェクト）

  1. Call Flowの出力をReturn Outputsカードの対応する入力にドラッグします。

  2. Connector AuthpingカードのauthオブジェクトをCall FlowカードのConnection入力フィールドにドラッグします。

  3. フローを保存し、テストダイアログにrequest_method、相対URL、その他の必要データを手動で追加してテストします。