★アクションの説明、概要
REST APIを実行する方法について説明しています。
★アクションの作成方法
★アクションの設定画面について
アクション設定画面の設定項目についての説明は以下の通りです。
１．基本設定
１－１．URL
APIのリクエスト先のURLを設定します。変数参照可能です。
１－２．リクエストタイプ
リクエストのタイプを設定します。
１－３．header
+で設定を追加、-で設定を削除できます。変数参照可能です。
変数参照したときの書き方は以下の通りです。書き方に即していない場合は、左側の表示が{}のままとなります。
{“変数名”:”値”}
１－３ー１．headerで＋をクリック、パラメーターの追加
・変数名
APIの変数名を指定します。
・値
設定した変数名へセットする値です。変数参照可能です。
１－４．parameter
+で設定を追加、-で設定を削除できます。変数参照可能です。
変数参照したときの書き方は以下の通りです。書き方に即していない場合は、左側の表示が{}のままとなります。
{“変数名”:”値”}
１－４ー１．parameter で＋をクリック、パラメーターの追加
・変数名
APIの変数名を指定します。
・値
設定した変数名へセットする値です。変数参照可能です。
１－５．parameterの値の中の改行を\nに置換する
parameterに設定した値の中に含まれる改行を\nに置換する場合は、チェックを入れます
１－６．Proxy
インターネット接続を行うときにProxyサーバを使用するか選択します。Proxyサーバの設定方法はこちらから
・Proxyを使用する
使用する場合は、こちらを選択します。
・Proxyを使用しない
使用しない場合は、こちらを選択します。
１－７．戻り値
REST APIの実行結果を格納する変数を設定します。
２．高度な設定
２－１．タイムアウト（秒）
REST APIを実行が終わるまでロボットが待機する時間を設定します。
２－２．HTTP Status
REST APIを実行した結果のステータスを格納する変数を設定します。
２－３．HTTP Reason
REST APIを実行した結果の理由文を格納する変数を設定します。
２－４．Basic認証 ユーザー
ユーザー名を入力します。変数参照できます。
２－５．Basic認証 パスワード
パスワードを入力します。変数参照できます。
２－６．証明書の検証
証明書の妥当性を検証する、しないを設定します。
・検証する
証明書の妥当性を検証する場合は、こちらを選択します。
・検証しない
証明書の妥当性を検証しない場合は、こちらを選択します。
２－７．アクション有効
このアクションを無効にする場合は、チェックを外します。
３．エラー発生時の対応
３－１． エラー時の処理
エラーが発生したときの設定を行います。詳細はこちらをご確認ください。
３－２．基点となる条件分岐
エラー時の処理で条件分岐の次のフローに移動を選択したときに、設定することができます。アクションでエラーが発生した場合、移動先の条件分岐を選択します。
３－３． エラー時にログ出力
エラーが発生したときにログに出力するか設定します。スケジュール実行したときのログへ出力されます。エラーとして扱わない場合は、チェックを外します。詳細はこちらをご確認ください。
★サンプル
以下サンプルです。
・URL
http://zipcloud.ibsnet.co.jp/api/search
・リクエストタイプ
POST
・ parameter
変数名をzipcode
値を1030001
・戻り値
戻り値に以下のように格納されます。
{
"message": null,
"results": [
{
"address1": "東京都",
"address2": "中央区",
"address3": "日本橋小伝馬町",
"kana1": "ﾄｳｷｮｳﾄ",
"kana2": "ﾁｭｳｵｳｸ",
"kana3": "ﾆﾎﾝﾊﾞｼｺﾃﾞﾝﾏﾁｮｳ",
"prefcode": "13",
"zipcode": "1030001"
}
],
"status": 200
}