• トップ
  • ステートの設定方法(API送信タイプ)

ステートの設定方法(API送信タイプ)

API送信タイプの機能を見ていきましょう。


[API送信タイプ]
API送信タイプは、別のアプリケーションやシステムへとデータを送信することができるステートです。
返り値を利用して応答することもできます。
メール送信タイプと同じく、特定のアクションやステートから遷移させることで通知として利用できる他、宛先や本文中に変数を指定することで、アクションのフォームや、ステートのフォーム穴埋めタイプで入力されたデータを利用することができます。


[使用例]
郵便番号から住所を検索するシステムのAPIを利用し、郵便番号を入力され、住所を応答する機能を考えます。


[設定例]
今回は、アクション、ステート(フォーム穴埋めタイプ)、ステート(API送信タイプ)を設定します。


[アクションの設定]

アクション名は、後ほどステート(フォーム穴埋めタイプ)の設定で利用するため、メモしてください。

ステートに遷移するための言葉を入力します。


[ステート(フォーム穴埋めタイプ)の設定 ステート基本情報]

ステート名は、後ほどステート(API送信タイプ)の設定で利用するため、メモしてください。
今回は「ex_state_api_input」と設定します。

「フォーム穴埋めタイプ」を選択します。

「アクション」を選択します。

先ほど作成したアクション名を入力します。

「sys_any_state」を選択します。

ステート(API送信タイプ)を作成した後、当ステートのステート名を選択します。

ステートに入った時の応答文を設定します。

今回は、ステートから出るときの応答文は設定しません。

キャンセルされたときの応答文を設定します。

理解できなかった時の応答文を設定します。


[ステート(フォーム穴埋めタイプ)の設定 フォーム定義]

項目名を設定します。
今回は「postalCode」と設定します。

郵便番号入力を促す応答文を設定します。

自由入力のみとなるため、[no menu]を入力します。


[ステート(API送信タイプ)の設定 ステート基本情報]

ステート名は、後ほどの応答文の設定で利用するため、メモしてください。
今回は「ex_state_api」と設定します。

「API送信タイプ」を選択します。

先ほど作成したステートを選択します。
今回は「ex_state_api_input」を選択します。

APIの呼び出し成功時、APIの返り値を利用して応答文を表示します。
{{ state.[ステート名].api_response.[返り値の項目] }}と記述することで、APIの返り値をそのまま表示することができます。
今回は、ステート名が「ex_state_api」、項目は「data.fullAddress」を利用するので、 {{ state.ex_state_api.api_response.data.fullAddress }}と入力します。

また、返り値は応答選択肢にも利用できます。
今回は「data.city」という返り値の項目を利用します。
{{ state.ex_state_api.api_response.data.city }}と入力します。

なお、{{ text }}と入力することで、ユーザーが直前に発言した会話文を表示できます。

APIの呼び出し失敗時の応答文を設定します。


[ステート(API送信タイプ)の設定 API定義]
外部システムの仕様に合わせ、送信するデータを設定します。

URLに、APIの送信先(エンドポイント)を設定します。
今回は、https://api.zipaddress.net/と入力します。
【参考】https://zipaddress.net/

HTTPメソッドを選択します。今回は「GET」を選択します。
[利用可能なHTTPメソッド]
 GET
 POST
 PUT
 DELETE

Content-Typeを選択します。今回は「application/json」を選択します。
[利用可能なContent-Type]
 application/json
 application/xml
 application/x-www-form-urlencoded
 application/javascript
 text/plain
 text/html
 text/css

HTTPヘッダーを設定します。
今回は必要ない為、追加しません。

パラメータのキーを設定します。
今回は「zipcode」を入力します。

パラメータの値を設定します。
今回は入力された値を利用するため、{{ state.ex_state_api_input.form.postalCode }}を入力します。


それでは、DEMOページで確認しましょう。

まずは、アクションとステート(フォーム穴埋めタイプ)が正しく起動されたことが分かりました。

ステート(フォーム穴埋めタイプ)で入力した郵便番号から、ステート(API送信タイプ)によって外部システムより住所が返り、正しく応答されました。


以上で、「API送信タイプ」というステートタイプの設定は完了です。連携したい外部システムの仕様に沿うよう設定してください。