RESTAPIの使い方

★アクションの説明、概要

REST APIを実行する方法について説明しています。


★アクションの作成方法


★アクションの設定画面について

アクション設定画面の設定項目についての説明は以下の通りです。

1.基本設定

1-1.URL

APIのリクエスト先のURLを設定します。変数参照可能です。

1-2.リクエストタイプ

リクエストのタイプを設定します。

1-3.header

+で設定を追加、-で設定を削除できます。

1-3ー1.headerで+をクリック、パラメーターの追加

・変数名

APIの変数名を指定します。

・値

設定した変数名へセットする値です。変数参照可能です。

1-4.parameter

+で設定を追加、-で設定を削除できます。

1-4ー1.parameter で+をクリック、パラメーターの追加

・変数名

APIの変数名を指定します。

・値

設定した変数名へセットする値です。変数参照可能です。

1-5.Proxy

Proxyサーバを使用するか選択します。Proxyサーバの設定方法はこちらから

・Proxyを使用する

Proxyサーバを使用する場合は、こちらを選択します。

・Proxyを使用しない

Proxyサーバを使用しない場合は、こちらを選択します。

1-6.戻り値

REST APIの実行結果を格納する変数を設定します。


2.高度な設定

2-1.タイムアウト(秒)

REST APIを実行が終わるまでロボットが待機する時間を設定します。

2-2.HTTP Status

REST APIを実行した結果のステータスを格納する変数を設定します。

2-3.HTTP Reason

REST APIを実行した結果の理由文を格納する変数を設定します。

2-4.Basic認証 ユーザー

ユーザー名を入力します。変数参照できます。

2-5.Basic認証 パスワード

パスワードを入力します。変数参照できます。

2-6.証明書の検証

証明書の妥当性を検証する、しないを設定します。

・検証する

証明書の妥当性を検証する場合は、こちらを選択します。

・検証しない

証明書の妥当性を検証しない場合は、こちらを選択します。

2-7.アクション有効

このアクションを無効にする場合は、チェックを外します。


3.エラー発生時の対応

3-1. エラー時の処理

エラーが発生したときの設定を行います。詳細はこちらをご確認ください。

3-2.基点となる条件分岐

エラー時の処理で条件分岐の次のフローに移動を選択したときに、設定することができます。アクションでエラーが発生した場合、移動先の条件分岐を選択します。

3-3. エラー時にログ出力

エラーが発生したときにログに出力するか設定します。スケジュール実行したときのログへ出力されます。エラーとして扱わない場合は、チェックを外します。詳細はこちらをご確認ください。


★サンプル

以下サンプルです。

・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
}

コメントを残す

このサイトはスパムを低減するために Akismet を使っています。コメントデータの処理方法の詳細はこちらをご覧ください