嵌入 API 让你自己的后端把你自己的终端用户注册或开通进一个 MailInApp 课程或网络研讨会,并把查看器嵌入到你的应用中——终端用户全程都不需要接触 MailInApp 仪表盘账户。
你的终端用户是你自己的,不属于 MailInApp——他们不应该仅仅为了观看一个由你代为托管的课程,就还要另外创建一个账户。
你的后端,你的权限判定
POST /api/v1/courses/[id]/enroll 为一个邮箱地址授予或撤销课程访问权限,POST /api/v1/webinars/[id]/register 则为一名网络研讨会参会者完成报名——两者都使用与发送 API 相同的持有者 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 快速入门。