デバイス・ユーザ認証について
ユーザがエージェントと対話をするためには、デバイス識別のためのIDの払い出しと、ユーザ識別のためのログインが必要になります。
デバイス識別のためのID(デバイスID)は、クライアントアプリを利用するデバイス毎に払い出す一意のIDです。ID体系の考え方についてはIDについてを参照ください。
デバイスに対するIDを払い出した後、エージェントに対してログインを実施することで、そのエージェントに対するユーザ識別子が発行され、対話が可能になります。
SDKを用いてクライアントアプリケーションを作成する際には、ドコモAIエージェントAPIが標準で用意している認証機構(UDSF,UDSDB)を用いたログインを利用するか、個別にログイン機能を実装する必要がございます。標準の認証機構では、dアカウントでのログイン機能をご用意しております(開発時に利用できるトライアル環境に関しては、googleアカウントでのログインも可能です)
各コンポーネントは、以下の流れで利用されます。
アプリでの利用フロー（IF詳細）
商用環境
| 番号 | 名称 | 接続先 | 備考 |
|---|---|---|---|
| 1 | DeviceId取得 | https://doubk. aiplat.jp/v1.0/dvo/doubk/devices | デバイスIDの払い出しを行う |
| 2 | アプリ用デバイス登録（GET） | https://doufr.aiplat.jp/device/registdeviceId=XXX&directAcc | デバイスIDの登録を行う 専用のcookieが作成され、次ログインの際、デバイス登録を行う事が出来る。 |
| 3 | ログイン画面 | https://doufr.aiplat.jp/login/view | ログイン画面からCIRCUSへログインを行う事でUDSへアクセスできる。 |
| 4 | Device Token取得 | https://doubk.aiplat.jp/v1.0/dvo/doubk/devices/token | デバイスIDから、デバイストークンを払い出す ※デバイス登録完了から5分以内に実施する |
| 5 | 対話 | wss://dospf. aiplat.jp:443/ciel | SPF用のSDKクライアントを使用する。 |
| 6 | Device Token再取得 | https://doubk.aiplat.jp/v1.0/dvo/doubk/devices/token/refresh | リフレッシュトークンからデバイストークンを払い出し直す |
※テキスト利用の場合はText Gatewayを利用して接続
トライアル環境
| ＜トライアル環境の利用フロー変更のお知らせ＞ 8/12よりトライアル環境の利用フローが変更となります。詳細はトライアル環境の利用フロー変更に関しましてをご参照ください。 |
※下記情報は8/12以降使用不可 トライアル環境新フローを参照
| 番号 | 名称 | 接続先 | 備考 |
|---|---|---|---|
| 1 | DeviceId取得 | https://mds-v2.sebastien.ai/api/issue_device_id またはAgentcraft™によりGUI上で取得 |
デバイスIDの払い出しを行う |
| 2 | アプリ用デバイス登録（GET） | https://users-v2.sebastien.ai/dashboard/device_registration?confirm=yes&device_id=XXX | デバイスIDの登録を行う 専用のcookieが作成され、次ログインの際、デバイス登録を行う事が出来る |
| 3 | ログイン画面 | https://users-v2.sebastien.ai/login/login | UDSへのログイン後、デバイス登録が完了する |
| 4 | Device Token取得 | https://users-v2.sebastien.ai/api/req_device_token | デバイスIDから、デバイストークンを払い出す |
| 5 | 対話 | wss://spf-v2.sebastien.ai/talk | SPF用のSDKクライアントを使用する |
| 6 | Device Token再取得 | https://users-v2.sebastien.ai/api/update_device_token | リフレッシュトークンからデバイストークンを払い出し直す |
デバイスでの利用フロー（IF詳細）
商用環境
| 番号 | 名称 | 接続先 | 備考 |
|---|---|---|---|
| 1 | ログイン画面 | https://doufr. aiplat.jp/login/view | ログイン画面からCIRCUSへログインを行う事でUDSへアクセスできる。 |
| 2 | デバイス登録 | https://doufr. aiplat.jp/device/regist | デバイスIDの登録を行う |
| 3 | Device Token取得 | https://doubk.aiplat.jp/v1.0/dvo/doubk/devices/token | デバイスIDから、デバイストークンを払い出す デバイス登録完了から5分以内に実施する |
| 4 | 対話 | wss://dospf. aiplat.jp:443/ciel | SPF用のSDKクライアントを使用する。 |
| 5 | Device Token再取得 | https://doubk.aiplat.jp/v1.0/dvo/doubk/devices/token/refresh | リフレッシュトークンからデバイストークンを払い出し直す |
※DeviceToken再取得について
実装方法（AOS）についてはこちらからドキュメントをダウンロードしてご利用ください。
トライアル環境
| ＜トライアル環境の利用フロー変更のお知らせ＞ 8/12よりトライアル環境の利用フローが変更となります。詳細はトライアル環境の利用フロー変更に関しましてをご参照ください。 |
※下記情報は8/12以降使用不可 トライアル環境新フローを参照
| 番号 | 名称 | 接続先 | 備考 |
|---|---|---|---|
| 1 | ログイン画面 | https://users-v2.sebastien.ai/login/login | UDSへのログイン |
| 2 | デバイス登録 | https://mds-v2.sebastien.ai/api/issue_device_id またはAgentcraft™によりGUI上で取得 |
デバイスIDの登録を行う |
| 3 | Device Token取得 | https://users-v2.sebastien.ai/api/req_device_token | デバイスIDから、デバイストークンを払い出す |
| 4 | 対話 | wss://spf-v2.sebastien.ai/talk | SPF用のSDKクライアントを使用する。 |
| 5 | Device Token再取得 | https://users-v2.sebastien.ai/api/update_device_token | リフレッシュトークンからデバイストークンを払い出し直す |
トライアル環境の利用フロー変更に関しまして
この度、開発時の手順簡素化を目的として、UDSにて提供していたデバイスID登録及びトークン発行・更新機能をAgentcraft™に移転致しました。
機能がAgentcraft™に集約されることにより、UDSへのユーザー登録・リダイレクトが不要となります。
機能移転に伴い、8/12をもちましてUDSでのデバイスIDの新規発行機能、トークン発行・更新機能は閉塞致します。
利用フローにつきましてはトライアル環境新フロー（IF詳細）を、
変更後のAPI仕様詳細についてはAPIを利用したデバイス登録をご覧ください。
なお、既にUDSにて発行済みのデバイスID・トークンの扱いについては以下の通りとなります。
・Agentcraft™のAPIを利用すれば、既存のデバイスIDからのトークンの発行及びトークンの更新が可能
・UDSで発行済みのトークンに関しては、UDSでのAPIでは今年中（2020/12末）、Agentcraft™では今年度（2021/3末）までご利用可能。以降のご利用は、Agentcraft™でのトークン更新が必要
接続先変更について
| 番号 | 名称 | 接続先（変更前） | 接続先（変更後） |
|---|---|---|---|
| 1 | DeviceId追加 | https://mds-v2.sebastien.ai/api/issue_device_id （※） |
https://api-agentcraft.sebastien.ai/devices （※） |
| 2 | Device登録 | https://users-v2.sebastien.ai/dashboard/device_registration | （不要） |
| 3 | Device Token生成 | https://users-v2.sebastien.ai/api/req_device_token | https://api-agentcraft.sebastien.ai/devices/token （※） |
| 4 | 対話 | 新：wss://acspf.aiplat.jp/ciel 旧：wss://spf-v2.sebastien.ai/talk（2021/06/24廃止） |
（変更なし） |
| 5 | Device Token更新 | https://users-v2.sebastien.ai/api/update_device_token | https://api-agentcraft.sebastien.ai/devices/token/refresh （※） |
※ ＝ Agentcraft™にてGUIでも実行可能
トライアル環境新フロー（IF詳細）
APIによるデバイス登録の仕様情報はAPIを利用したデバイス登録をご覧ください。
また、APIによるデバイス登録だけでなく、Agentcraft™の設定タグにてGUI上でもデバイスID発行やトークン発行・更新が可能です。GUIの設定方法については、デバイスとの紐付け方法をご覧下さい。
| 番号 | 名称 | 接続先 | 備考 |
|---|---|---|---|
| 1 | ClientSecret取得 | Agentcraft™の設定タグよりGUI上で取得 | クライアントシークレットを取得する |
| 2 | DeviceID追加 | https://api-agentcraft.sebastien.ai/devices （※） |
デバイスIDの発行・登録を行う |
| 3 | DeviceToken生成 | https://api-agentcraft.sebastien.ai/devices/token （※） |
デバイスIDから、デバイストークンを払い出す |
| 4 | 対話 | 新：wss://acspf.aiplat.jp/ciel 旧：wss://spf-v2.sebastien.ai/talk（2021/06/24廃止） |
SPF用のSDKクライアントを使用する |
| 5 | Device Token更新 | https://api-agentcraft.sebastien.ai/devices/token/refresh （※） |
リフレッシュトークンからデバイストークンを払い出し直す |
※ ＝ Agentcraft™にてGUIでも実行可能