カスタマイズシナリオでご利用いただけるAPI連携ブロックについてご紹介します。
※API連携はPRO・旧プラン(スタンダード・フリー)のみご利用可能です。
シナリオ＞新規作成時または既存で作成されているシナリオの種類が「カスタマイズシナリオ」の場合ご利用いただけます。
1. 基本設定項目
・ブロック名
API連携のブロック名を任意で入力します。
・メソッド
HTTPのリクエストメソッドを指定します。GET、POST、PUT、DELETEから選択可能です。
・URL
連携したい外部APIのエンドポイントURLを入力してください。
URLパラメータを使用することも可能です。
・情報参照名
外部連携の結果を他のブロックで利用する際の参照名（変数）です。
情報参照名は英数字とアンダースコア(_)のみを使用し、先頭は英字にする必要があります。アンダースコア(_)で終了したり、アンダースコア(_)を2つ続けたりすることはできません。
2. 詳細設定項目
・ヘッダ
HTTPリクエスト/レスポンスに追加情報を付与できます。
キーと値のペアを登録します。
認証情報を渡す際に使用されることもあります。
・ボディタイプ
None: Bodyなし。
json: json形式でリクエストボディを指定できます。
form-data: キー/値ペアでリクエストボディを指定できます。
x-www-form-urlencoded: キー/値ペアでリクエストボディを指定できます。
文字列はダブルクォーテーションで囲みます。
・タイムアウト
APIの応答を待つ最大の秒数を指定します。
・テスト接続
上記で設定した外部連携設定を実行して、テスト接続することができます。
3. その他
・成功と失敗
・HTTP STATUSが200台となります。それ以外は失敗扱いです。
・外部サーバーがダウンしている、インターネットに繋がらないなどの通信エラーも失敗にカウントされます。
・取得データはドット「.」でアクセスできます
情報参照名に「response」を指定してください。