OAuth 認証の連携
- 印刷する
- PDF
OAuth 認証の連携
- 印刷する
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Classic/VPC環境で利用できます。
登録された認証サーバとの連携により、認証が完了したユーザーにのみ返答することができます。初回の認証が完了すると、そのユーザーの情報が維持される間は追加の認証手続なしに返答します。
認証サービスと連携させる方法は以下のとおりです。
- NAVERクラウドプラットフォームコンソールでServices > CLOVA Chatbot > Domainメニューを順にクリックします。
- 希望するドメインの [ビルダーを実行する] ボタンをクリックしてチャットボットビルダーを実行します。
- チャットボットビルダーで チャットボット設定 > サービス連携 タブをクリックします。
- 認証サービスの [連携] ボタンをクリックします。
- サービス連携画面で認証URLを入力します。
- ユーザーが質問を入力すると、チャットボットは認証されたユーザーであるかどうかを判断するためにPOST {URL}/confirmを呼び出し、入力された認証サーバに認証有無の確認を求める
- {URL}は、ドメイン管理者が入力した認証URL
- チャットボットは、ユーザーのIDとプラットフォーム情報を一緒に伝達
{
"userId": "${userId}",
"platform": "${platform}",
"domainCode":"${domainCode}"
}
値 | 必須 | タイプ | 説明 |
---|---|---|---|
userId | Y | String | ユーザーのID |
platform | Y | String | メッセンジャープラットフォーム |
domainCode | Y | String | 現在ドメインのコード |
- 認証されたユーザーには、認証サーバは以下のように応答します。
{
"valid": true
}
値 | 必須 | タイプ | 説明 |
---|---|---|---|
valid | Y | Boolean | 認証されたユーザーであれば、trueをリターン |
- 認証リクエストメッセージと認証失敗メッセージ、認証エラーメッセージを入力し、[連携] ボタンをクリックします。
- 認証されていないユーザーや、認証に失敗したユーザーの場合、チャットボットは 認証リクエストメッセージまたは認証失敗メッセージとともにLoginリンク付きのURLボタンをユーザーに返します。
GET {URL}/login?userId=${userId}&platform=${platform}&domainCode=${domainCode}
- Loginに成功すると、認証サーバはInvoke URLを呼び出します。
Invoke URLを呼び出す場合、以下のデータが含まれている必要があります。{ "domainCode": "String", "platform": "String", "userId": "String", "nonce": "Option[String]", "needPush": true }
値 | 必須 | タイプ | 説明 |
---|---|---|---|
platform | Y | String | メッセンジャープラットフォーム情報 |
userId | Y | String | ユーザー識別のためのID |
nonce | Y | String | linkに用いられる一時的な暗号。 nonce値が存在する場合、link APIを呼び出す際に渡されたnonce値を持たせて呼び出す |
needPush | Y | Boolean | 返答が見つかってpushが必要な場合に使用。 LINE、TalkTalkメッセンジャーのみサポート |
- ログイン成功リクエストがチャットボットビルダーに伝達されると、そのユーザーの認証成功に対する確認としてlinkをリクエストします。
POST {URL}/link
{
"userId": "String",
"platform": "String",
"domainCode": "String",
"nonce": "Option[String]"
}
値 | 必須 | タイプ | 説明 |
---|---|---|---|
userId | Y | String | ユーザー識別のためのID |
platform | Y | String | メッセンジャープラットフォーム情報 |
domainCode | Y | String | ドメインを識別するためのドメインコード |
nonce | N | String | 渡されたnonce値が存在する場合、APIを呼び出す際に渡された値を持たせて呼び出す |
- POST {URL}/linkを呼び出したときに200OKが渡されたらlinkに成功したと判断します。
- linkに成功すると、ユーザーが最初の開始時に質問した内容に対する返答を見つけて応答します。
- linkに失敗すると、認証失敗メッセージとともに再ログインを誘導します。
- ログイン成功リクエストでneedPush: trueである場合、pushが可能なプラットフォームであれば、見つかった返答をpushします。
この記事は役に立ちましたか?