埋め込みAPIを使えば、自社のバックエンドが自社のエンドユーザーをMailInAppのコースやウェビナーに登録・受講登録させ、視聴体験を自社アプリに埋め込めます — そのユーザーがMailInAppのダッシュボードアカウントに一切触れることはありません。
自社のエンドユーザーは自社のものであり、MailInAppのものではありません — 自社が代わりにホストしているコースを見るためだけに、別のアカウントを作らされるべきではありません。
自社のバックエンド、自社の権利判断
POST /api/v1/courses/[id]/enrollはメールアドレスに対するコースアクセスを許可・取り消しし、POST /api/v1/webinars/[id]/registerはウェビナー参加者を登録します — どちらも送信APIと同じBearer APIキーで認証されます。誰に権利があるかは自社の請求やチェックアウトシステムが決め、MailInAppはその結果をレンダリングするだけです。
実際のビューアーを埋め込む
受講登録が済むと、POST /api/v1/courses/[id]/embed-tokenが短命な署名付きトークンを発行します。自社アプリのiframeやウィンドウを返されたURLへリダイレクトすると、裏側で決定的なサインインが自動的に行われます — エンドユーザーは常に自社アプリを目にし、MailInAppのログインを目にすることはありません。
望むなら、登録の周りにインタラクティブメールを
コースやウェビナーのlifecycleBindingsは、registered/reminder/enrolled/completedの各イベントをスタジオプロジェクトへ向けることができます — 本物の参加ボタンを持つミーティングリンクや、開始時刻までのカウントダウンなどです。何も紐付けられていない場合は自動的にプレーンテキストの文面にフォールバックするため、オプトインしても既存の設定が壊れることはありません。
同じキー、専用の割り当て
埋め込みAPIは、送信APIのキーごとに毎分60リクエストの上限を共有し、さらにプランごとの専用の月間呼び出し割り当てがあります — Free/Starterではゼロで、送信API自体がそれらの階層でゲートされているのと同じです。
はじめに
開発者セクションでAPIキーを発行し、自社のバックエンドから登録または受講登録のエンドポイントを呼び出し、その後埋め込みトークンを発行してそこへリダイレクトします — リクエストの完全な形式は埋め込みAPIクイックスタートを参照してください。