次に、HTTP(S)の外部システム連携の実装手順について説明します。

  実装例(HTTP(S))

  1. (外部API) 外部システム連携設定
    JSONを返すAPIを用意してください。今回は「OpenWeatherMap」のAPIを利用します。

    1-1. API利用にはAPIキーが必要です。〔OpenWeatherMap-ユーザー登録〕へアクセスし、ユーザー登録をしてください。

    ・ユーザー名を入力してください。
    ・メールアドレスを入力してください。
    ・パスワードを入力してください。
    ・もう一度、パスワードを入力してください。
    ・利用規約とプライバシーポリシーに同意する場合はチェックをしてください。
    同意しなければ登録はできません。
    ・ニュース、アップデート、オファーに関するメールを受け取ることに同意する場合はチェックをしてください。
    ・チェックを押して表示されるメッセージに従ってロボットではないことを証明してください。
    ・”Create Account”ボタンをクリックし、登録してください。

    1-2. ページ上部の”Hello ユーザー名”をクリックすると、ユーザー情報の編集画面へ遷移します。

    1-3. API Keysのタブをクリックしてください。

    1-4. 表示されているAPI Key を控えておいてください。
  2. (DialogPlay) チャットボット作成
    2-1. 左メニューの『チャットボット一覧』を選択し、『チャットボット一覧』から”新規作成” ボタンをクリックしてください。

    2-2. 『チャットボット名』、『初期発言』を入力し、”保存” ボタンをクリックしてください。


  3. (DialogPlay) 外部システム連携設定
    3-1. チャットボット画面に戻り、『外部システム連携』タブから ”新規作成”ボタンをクリックしてください。
    3-2. 『外部システム連携先』に外部システム連携名、『説明』に作成する外部システム連携の説明を入力してください。
    3-3. 連携先の設定をしてください。

    ・『タイプ』は、「HTTP(S)」を選択してください。
    ・『URL』は、接続先URLを入力してください。
    URL入力例:http://api.openweathermap.org/data/2.5/forecast?q={{エリア}},JP&units=metric&APPID= API Key
    API Key へ〔 1-4. 〕の④で控えた文字列を入力してください。
    ・『Method』は、GETを使用します。
    ・『Headers』は、GETのため使用しません。
    ・『Request Body』は、GETのため使用しません。

    3-4. 外部連携先から受け取る値を下記のように設定をしてください。

    ・デフォルトで「JSON」が選択されます。
    ・『変換元』にJSONのキー(外部システムから受け取る値)を入力し、『変換先』にシナリオ使用時に使う変数名を入力してください。

    Response値:
    今回のシナリオでは3時間後の気象データを利用するため、リスト番号(list[1])を設定しています。
    ※パラメーターに関する詳細は〔 こちら 〕をご覧ください。

    3-5. 上記を設定した後、”保存”ボタンをクリックしてください。

  4. (DialogPlay) シナリオ作成
    4-1. チャットボット画面に戻り、『シナリオ一覧』タブから”新規作成”ボタンをクリックしてください。
    4-2. 『シナリオ名』と『ユーザー発言例(発言例タブ)』を入力してください。
    4-3. 『シナリオの流れ』エリアの中にあるリストから「テキスト発言」を選択し、”アクションを追加”ボタンをクリックしてください。
    4-4. 下記のように『発言内容』を入力してください。
    4-5. 『シナリオの流れ』エリアの中にあるリストから「ヒアリング」を選択し、”アクションを追加”ボタンをクリックしてください。
    4-6. 『ヒアリング項目』に下記の内容を設定してください。
    No. ヒアリング項目名 タイプ 項目ごとの質問文
    1 エリア @text 地域をローマ字で入力してください。 札幌市の場合はSapporoまたはSapporo-shi
    4-7. 『シナリオの流れ』エリアの中にあるリストから「外部システム連携」を選択し、”アクションを追加”ボタンをクリックしてください。
    4-8. 連携先に先ほど外部システム連携で作成した「3時間後の天気」を選択し、画面右側の『変数一覧』に設定した変換先が表示されたことを確認してください。
    4-9. 『シナリオの流れ』エリアの中にあるリストから「テキスト発言」を選択し、”アクションを追加”ボタンをクリックしてください。
    4-10. 下記のように『発言内容』を入力し、”保存”ボタンをクリックしてください。
    変数を利用するには、シナリオ作成画面右側にある『変数一覧』に表示されている変数名を{{}}で括ってください。

    4-11. 「学習データが更新されています。反映するには学習ボタンを押してください。」というメッセージが表示されますので、”保存してチャットボットを学習” ボタンをクリックしてください。
  5. 画面右端にある『シミュレーター』をクリックし、動作を確認してください。


    ※本手順では、各種気象データの無料APIを提供するオンラインサービス:Openweathermapを利用しています。
    (ライセンスは、OpenStreetMapのクリエイティブ・コモンズCC-BY-SA2.0に準じます)
    他社が提供しているAPIを利用される場合は、サービス提供元の利用規約を必ずご確認の上、ご利用下さい。

Last updated on 2018/12/11.