クイックスタート
埋め込みAPIは、自分のバックエンドから自社のエンドユーザーをMailInAppのコースやウェビナーに登録・受講登録させ、視聴・参加体験を自分のアプリに埋め込めるようにします — そのエンドユーザーがMailInAppダッシュボードのアカウントに一切触れることはありません。これはトランザクション送信APIと同じベアラーAPIキーを共有します — 新しい認証情報を発行する必要はありません。
キーを発行する
他のどこでも使うのと同じキーです: ダッシュボードの開発者でキーを作成を押します。完全なキー — mia_live_... — は一度だけ表示されます。MailInAppはハッシュのみを保持します。1つのキーで、あなたのアカウント上のすべてのルート(以下のものを含む)を呼び出せます。
ウェビナー参加者を登録する
エンドユーザーを公開登録ウェビナーに登録し、参加リンクを返します — MailInAppのフォームもMailInAppアカウントもユーザーには不要です:
curl -X POST https://mailinapp.com/api/v1/webinars/<liveSessionId>/register \
-H "Authorization: Bearer mia_live_..." \
-H "Content-Type: application/json" \
-d '{
"email": "[email protected]",
"name": "Ada Lovelace"
}'
呼び出しが成功すると、確定した参加リンクまたはキャンセル待ちステータスのいずれかが返されます:
{ "status": "confirmed", "joinUrl": "https://mailinapp.com/webinar/.../join?token=..." }
ウェビナー自体も同じ方法で作成できます — POST /api/v1/webinars — または、ダッシュボードのライブから既に作成済みのものを再利用できます。いずれの場合もaccessMode: "registration"である必要があります。完全なリクエスト/レスポンスの形式については、APIリファレンスを参照してください。
コース登録者を受講登録する
メールアドレスに対してコースへのアクセスを許可(または取り消し)します — 誰に権利があるかを決めるのは自分自身の課金またはチェックアウトシステムであり、MailInAppはコースをレンダリングするだけです:
curl -X POST https://mailinapp.com/api/v1/courses/<courseId>/enroll \
-H "Authorization: Bearer mia_live_..." \
-H "Content-Type: application/json" \
-d '{
"email": "[email protected]",
"active": true
}'
{ "subscriberId": "abc123", "active": true }
コースビューアーを埋め込む
登録者が受講登録されたら、短期間(5分間)だけ有効な署名付きトークンを発行し、自分のアプリのiframeやウィンドウを返されたURLへリダイレクトします:
curl -X POST https://mailinapp.com/api/v1/courses/<courseId>/embed-token \
-H "Authorization: Bearer mia_live_..." \
-H "Content-Type: application/json" \
-d '{ "email": "[email protected]" }'
{ "portalUrl": "https://mailinapp.com/learn/<slug>/courses/<courseId>/embed?token=..." }
portalUrlを開くと、訪問者はトークンを引き換えるブートストラップページにサインインし、直接受講登録された登録者が得るのと同じコースポータル — 動画、進捗、クイズ — に到達します。これが成功するには、コースがpublishedであり、アカウントが既にメンバーシップスラッグ(/learn/<slug>)を取得済みである必要があります。
本当の差別化要素: インタラクティブなライフサイクルメール
登録、リマインダー、受講登録、完了のメールはすべて引き続き送信されます — 既定では、現在の単純な確認文言のままです。ダッシュボード内のコースまたはウェビナー自身の設定パネルにある、新しいライフサイクルメールセクションでは、それらのイベントのいずれかを、代わりにスタジオで作成したプロジェクトに向けることができます。すると送信されるメールは、ハードコードされた文字列ではなく、フォールバックエンジン全体(キネティックブロック、マージタグ、ライブビュー)を通じてレンダリングされます。紐付けを行わないイベントは何も変わりません。