使い始める前に準備すること
先に埋め込み方式を選び、その経路の本番前チェックを揃える。
対象:調達 / 連携担当 · 適用:DodoSpeak Oral
目標:本番前に埋め込み方式を決め、その経路でプラン、キー、マウント、完了確認を列挙する。トライアル中は方式を変えられる。本番後はロック。両方必要なら Oral テナントをもう一つ開き、独立して動かす。
向き不向きは DodoSpeak Oral とは、Oral・SaaS・プライベートデプロイの選び方。方式の対照は 2つの正式な埋め込み。
調達が決めること
- プラン:Speak Lite / Class / Assess / Exam。課題・記録・試験を「使えるか」を決める。4 つの入口をプランで隠さない。 詳細は プラン・権限と使用量。
- テナント:開通後にテナント識別子と テナントキー(バックエンドのみ)。公式サイトで スピーキング接続台 のトライアル(サンドボックス)を先に開いてよい。本番テナントとテナントキーは商談開通が正。
- 使用量:50 人パック と課金分数(分数プールと課金)。開設フォームの 想定学習者規模 がパック数の提案に使われる。Oral はフル SaaS より同分あたり約 2/3。
埋め込み方式は本番の分岐であり、別価格帯ではない。ページウィジェット と ログイン換票 は能力も Oral 単価も同じ。トライアル中は接続台で切り替え可。本番前にロックする。両方必要 → Oral テナントをもう一つ開く。下文と 2つの正式な埋め込み。
連携が準備すること
この順で進める。初日に全部やる必要はない。
-
ページウィジェットかログイン換票を選ぶ(分岐点)
サーバーがない / ログインを変えられない → ページウィジェット(名簿の学習者コードが必要)。既にログインがあり、学籍で LMS に書き戻したい → ログイン換票。対照は 2つの正式な埋め込み。
トライアルは変更可。本番後はこのテナントがロックされ、自己操作では変えられない。両方必要なら Oral テナントをもう一つ開く。同じ学校にテナントを 2 つ付けてよい(ウィジェット一式、換票一式)。使用量、キー、名簿 / 換票の身元は分け、独立して動かす。1 つの本番テナントで 2 方式を途中で切り替える、と書かない。 -
資格情報(選んだ方式に合わせる)
- 換票:テナントキー で自社サーバーから 埋め込みトークン を発行。ブラウザ、アプリバンドル、フロントのリポジトリにテナントキーを置かない。
- ウィジェット:公開可能キー を使い、Origin を登録し、名簿の学習者コード(または OTP/PIN)を用意する。店キーはページに入れない。
-
フロントでマウント
コンテナを置き、埋め込みスクリプトを読み、OralEmbed.mount。表面は練習 / 課題 / 記録 / 試験(プランが許すもの)。テーマ token で見た目を変えられる。自社システムへの埋め込み方。 -
完了の正は API
埋め込みは「完了したように見える」コールバックを出す。得点・提出・使用量は自社バックエンドが Oral API(または Webhook)で確認する。試験成績の取得と記録の見方。 -
Origin とセキュリティ
埋め込みを許す Origin を登録。必要なら CSP / iframe 祖先。マイクはブラウザが学習者に許可を求める。 -
(任意)先に接続台で対照
公式サイトでトライアル開設(想定学習者規模を含む)→ スピーキング接続台 にログインし、受講者 / 公開者 / 管理者 / 開発者を一通り見る(管理者は 管理者:設定ハブ、請求、名簿)。トライアル中は設定で埋め込み方式を切り替えられる。この 4 役割を本番製品の役割として書かない。
本番前チェック
先に埋め込み方式を選び、その経路だけを完了する。共用項目はどちらも必要。
先に埋め込み方式を選ぶ
- ページウィジェット または ログイン換票 を選定した(2つの正式な埋め込み)
- トライアルは変更可、本番後はこのテナントがロックされることを理解した
- 両方必要なら:Oral テナントをもう一つ開き、2 系統を独立運用する(店キーを共用しない。1 つの名簿だけを唯一の身元源にしない)
共用(どちらの方式でも)
- プランと使用量の契約口径が確認済み
- 少なくとも 1 表面で
OralEmbed.mountして発話できる - 本番ドメインの Origin / CSP を登録した
- 完了 / 成績を API で突合している(書き戻しが必要な場合)
- プラン不足時の表示を設計した(API は拒否、ボタンは残す)
ページウィジェットのみ
- 名簿が用意でき、学習者コード(または OTP / PIN)を発行できる
- 公開可能キー を使う。テナントキーはページに入れない
- 学習者が先に本人確認(コード入力 / スキャン)してから発話できる
ログイン換票のみ
- テナントキー はサーバーのみ
- 短命の 埋め込みトークン を発行・更新できる
- 外部ユーザー id が LMS の学籍と揃っている
「短命トークンを発行できる」は換票だけ。ウィジェットは本人確認のあとプラットフォームが代行発行する。両方にチェックしない。