カスタム認証
カスタム認証の設定方法をご案内いたします。
カスタム認証とは
カスタム認証はシングルサインインを提供する機能です。
ウェブサイトやアプリとtriplaチャットボットを連携させる場合に、サイトやアプリのログインすればtriplaチャットボットにも同時にログインできるようにする機能です。チャットボットを呼び出すコードにtokenを追加して呼び出し、チャットボットが開く際にそのtokenでウェブサイトやアプリ提供者のユーザー情報取得のWebAPI を呼び出します。
ユーザー情報が取得できればそのユーザー情報でtripla チャットボットに自動的にログインした状態でチャットボットが開きます。
チャットボットでのカスタム認証
カスタム認証を設定するために必要なステップ
1. 下記の設定画面の指示に従い、連携するサイトやアプリの認証情報を取得するためのWebAPIを設定します。
2. ウェブサイトやアプリからチャットボットを呼び出す際にtripla ボットのコードを設定画面から取得したものに、data-user-token パラメータを追加します。
data-user-tokenに記述するtoken の値は連携するサービス側で生成してください。
チャットボットが呼び出されるとそのdata-user-token を下記設定画面で設定したユーザー情報APIに呼び出す際に{{client_token}} で指定した部分に代入され呼び出しを行います。data-user-tokenで受け取れるtokenはJWT フォーマットです。
triplaチャットボットのコードは施設管理画面から[設定]→[ウィジェット設定]→[設定]から確認可能です。
設定コードの例：
通常 <script async src="https://tripla.jp/sdk/javascript/tripla.min.js" data-triplabot-code="60xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx51"> </script>
token を追加する場合
<script async src="https://tripla.jp/sdk/javascript/tripla.min.js" data-triplabot-code="60xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx51" data-user-token="eyXXXXXXXXXXXXXXXXVCJ9.eyXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c”> </script>
施設管理画面から[設定]→[カスタム認証]を選択します。
カスタム認証をONにすると下のようなポップアップが表示されます。
表の通りに入力を行ってください。
アプリでユーザがログインしている場合、そのユーザーのtokenを受け取ってチャットを開きパートナーAppからもらったtokenを利用しtriplaチャットボットユーザーを特定してしまうとセキュリティ上懸念がある為、そのtokenとコンシェルジュマネージャーで設定してもらった秘密鍵でカスタマーのサーバーを呼び出します。
タイトル | 詳細 |
秘密鍵 | JWTユーザートークンを暗号化/復号化するために使用される秘密鍵を入力します。設定されていない場合は、client-user-token で受け取ったtoken をそのまま{{client_token}} の値として渡します。 秘密鍵の設定がない場合は設定不要です。 |
ユーザー情報API | GET/POST : GETを選択します。 パートナーAPI (Customer info API) 呼び出しURLを入力します。 |
ヘッダー | ユーザー情報APIでtoken をヘッダーで受け取る場合にここに受け取りパラメーターを指定します。 {{client_token}} の内容をtokenとして渡します。 |
パラメーター | ユーザー情報APIがtoken をパラメーターで受け取る場合は、ここにパラメーター名とその値として{{client_token}}を指定します。 |
応答データをユーザー属性にマップします | user_name : ユーザ情報APIがユーザ名を返す場合はレスポンスのユーザ名のパラメータ名を設定します。 user_email : ユーザ情報APIがユーザーのemailを返す場合はレスポンスのemailのパラメータ名を設定します。 uid : レスポンスのユーザーIDが入るパラメーター名を設定しあます。このユーザーIDがtripla チャットボットのユーザーIDと一意に紐付けされます。 |
例：
設定が完了すると下の画像のような表示に切り替わります。
こちらでカスタム認証の設定は終了です。
ブッキングウィジェットでのカスタム認証
ブランド管理画面から[管理者設定]を選択します。
[カスタム認証]を選択します。
カスタム認証をONにすると下のようなポップアップが表示されます。
表の通りに入力を行ってください。
タイトル | 詳細 |
client_tokenのURLパラメータ名 | client_tokenを渡すためのURLパラメータ名を設定してください。このURLパラメータはブッキングウィジェットURLパラメーターと組み合わせて使用されます。 |
ユーザー情報API | POSTを選択します。 パートナーAPI (Customer info API) 呼び出しURLを入力します。 |
ヘッダー | content-typeはapplication/soap+xmlのみ有効です。 |
ボディ | ユーザー情報APIがtokenをボディで受け取る場合は、ここに要素名とその値として{{client_toke}}を指定します。 |
応答データをユーザー属性にマップします | uid : レスポンスのユーザーIDが入る要素名を設定します。このユーザーIDがtripla ブッキングウィジェットの会員IDと一意に紐付けされます。 |
設定が完了すると下の画像のような表示に切り替わります。
こちらでカスタム認証の設定は終了です。
最終更新
