Web Account Link APIに公開

本記事では、Web Account Link APIを利用するチャットボットの公開手順と簡単な利用手順について説明します。

なお、Web Account Link APIは、Web Account Link APIオプションプランに加入することでご利用可能です。
オプションプランの詳細やお申し込み方法などについては、弊社営業担当、もしくはDialogPlay問合せ窓口 までお問い合わせください。

Web Account Link APIの利用方法は、大きく以下の流れとなります。

1. アプリケーションの公開
2. APIキーの取得
3.ログイン時処理の変更
4. チャット中の動作
5. リンクトークンの有効期限更新
6. リンクトークンの破棄

以下のトピックで、各詳細について説明します。

1. アプリケーションの公開

DialogPlay設定画面上でチャットボットの作成を行い、アプリケーションを公開します。

2.APIキーの取得

公開後に表示される『APIキー』を今後の認証で使用しますので、控えておいてください。

3. ログイン時処理の変更

アカウント連携のシーケンスは以下のようになります。
既存システムの実装によって多少変化しますが、赤枠で囲まれた個所について以下の説明とサンプルプロジェクト（link_sample.zip）を元に実装を行います。

1.ユーザーID/パスワードなどを用いて既存システムへの認証を行います。
2.既存システムのAPIを呼び出すためのアカウント連携IDを生成します。既に認証機構がある場合には認証情報をアカウント連携IDとして使用することも可能です。
3.[追加実装] https://api.dialogplay.jp/account_link/v1/link を呼び出して、連携に使用するリンクトークンを発行します。
4.[追加実装] レスポンスからリンクトークンを取得し、セッションなどで管理します。
5.[追加実装] <script>タグを用いてチャットボットを埋め込む際、data-link-tokenとして4番で取得したリンクトークンを指定します。

4. チャット中の動作

チャット中の動作は以下のようになります。
なお、チャットログについてはブラウザ単位で管理されるため、別ブラウザで開いた場合には同一ユーザーであっても過去ログが引き継がれず、新しい対話が開始されます。

1.ユーザー発言毎にリンクトークンの有効期限がチェックされます。有効期限切れの場合、チャットボットがエラー発言を返します。 2.シナリオ実行中は@アカウント連携ID、@ユーザー名、@ユーザー表示名のシステム変数を用いた返信が行えます。
3.外部システム連携で@アカウント連携IDを用いることで、既存システムのAPIを呼び出すことが出来ます。
4.@アカウント連携IDを用いてAPIの認証を行います。
5.APIの実行結果を返すことで、実行結果をチャットボットの返信に使うことができます。

5.リンクトークンの有効期限更新

前項でも記載した通り、ユーザー発言毎にリンクトークンの有効期限がチェックされます。
ログイン（/linkの呼び出し）から24時間で有効期限切れになるため、既存システムのセッションがそれよりも長い場合はログインから長時間経過した場合にチャットボットが使えなくなることがあります。
この場合は、以下の手順でAPIを呼び出すことでリンクトークンの有効期限を更新することができます。

1.ページ遷移時のセッションチェックなど、定期的に行われる処理を利用します。
2.[追加実装] https://api.dialogplay.jp/account_link/v1/refresh を呼び出します。

6. リンクトークンの破棄

発行から24時間で自動的に無効化されますが、ログアウト時はリンクトークンの破棄をおすすめします。
これによって、ログアウトしたユーザーのリンクトークンは即座に無効化され、チャットボットの利用も行えなくなります。

1.ログアウト処理を呼び出します。
2.既存システムのAPI呼び出しを制限するため、アカウント連携IDを削除します。
3.[追加実装] https://api.dialogplay.jp/account_link/v1/unlinkを呼び出します。