Incorporando Cursos e Webinars Interativos no Seu App

Seus usuários finais são seus, não do MailInApp — a Embed API permite que o seu backend os matricule ou inscreva em um curso ou webinar e incorpore o visualizador real no seu app, com a sua própria cobrança decidindo o direito de acesso, enquanto o MailInApp cuida da hospedagem, do vídeo e dos e-mails de ciclo de vida ao redor disso.

Assunto

You're registered — here's your link

A Embed API permite que o seu próprio backend registre ou matricule seus próprios usuários finais em um curso ou webinar do MailInApp e incorpore o visualizador no seu app — sem que esse usuário chegue a tocar em uma conta do painel do MailInApp.

Seus usuários finais são seus, não do MailInApp — eles não deveriam precisar criar uma conta separada só para assistir a um curso que você está hospedando em nome deles.

Seu backend, seu direito de acesso

POST /api/v1/courses/[id]/enroll concede ou revoga acesso a um curso para um endereço de e-mail, e POST /api/v1/webinars/[id]/register inscreve um participante de webinar — ambos autenticados com a mesma chave de API bearer da Send API. O seu próprio sistema de cobrança ou checkout decide quem tem direito; o MailInApp só renderiza o resultado.

Incorpore o visualizador real

Uma vez matriculado, POST /api/v1/courses/[id]/embed-token gera um token assinado de curta duração. Redirecione o iframe ou a janela do seu app para a URL retornada, e ele inicializa um login determinístico nos bastidores — o usuário final vê o seu app o tempo todo, nunca um login do MailInApp.

E-mails interativos ao redor da inscrição, se você quiser

As lifecycleBindings de um curso ou webinar podem apontar os eventos registered/reminder/enrolled/completed para um projeto do estúdio — um Link de reunião com o botão Participar de verdade, uma Contagem regressiva até o horário de início. Volta automaticamente para o texto simples padrão quando nada está vinculado, então optar por isso nunca quebra uma configuração já existente.

Mesma chave, cota própria

A Embed API compartilha o limite de 60 requisições por minuto por chave da Send API, além da própria cota mensal dedicada de chamadas por plano — zero no Free/Starter, igual à forma como a própria Send API é limitada nesses níveis.

Começando

Crie uma chave de API em Desenvolvedores, chame o endpoint de inscrição ou matrícula a partir do seu backend, depois gere um token de incorporação e redirecione para ele — veja o início rápido da Embed API para os formatos completos de requisição.

Uma sequência típica de criação e envio

1
Crie uma chave de API
A Embed API compartilha a mesma chave de API bearer da Send API transacional — uma única chave autentica toda rota da sua conta.
2
Inscreva ou matricule seu usuário final
POST /api/v1/webinars/[id]/register para um webinar com inscrição obrigatória, ou POST /api/v1/courses/[id]/enroll para acesso a curso — seu próprio backend chama isso, sem nenhum formulário ou conta do MailInApp envolvidos.
3
Incorpore o visualizador
POST /api/v1/courses/[id]/embed-token gera um token assinado de curta duração; redirecione o iframe ou a janela do seu app para a URL retornada para entregar a experiência real de curso/webinar.
4
Vincule os e-mails de ciclo de vida, opcionalmente
As lifecycleBindings de um curso ou webinar podem apontar os eventos registered/reminder/enrolled/completed para um projeto do estúdio, para que esses e-mails carreguem blocos interativos reais em vez do texto simples padrão — caindo de volta automaticamente se nada estiver vinculado.

Blocos criados para isso

Perguntas frequentes

O usuário final precisa de uma conta do painel do MailInApp?

Não — esse é o objetivo da Embed API. Um token de incorporação assinado inicializa um login determinístico nos bastidores, então o usuário final só vê o seu app, nunca um login ou painel do MailInApp.

Quem decide se um usuário tem direito de acesso a um curso?

Você — o seu próprio backend chama o endpoint de matrícula para conceder ou revogar acesso com base no seu próprio sistema de cobrança ou checkout. O MailInApp só renderiza o curso; ele não é a fonte da verdade sobre quem pagou.

Os e-mails de inscrição/lembrete podem incluir blocos interativos como uma campanha normal?

Sim, assim que um curso ou webinar tiver uma entrada em lifecycleBindings apontando esse evento para um projeto do estúdio — ele é renderizado pelo mesmo pipeline de qualquer outro envio, motor de fallback incluído. Sem uma vinculação, o evento continua enviando o texto simples de ciclo de vida já existente, então nada quebra se você não optar por isso.

Existe um limite de taxa ou cota separado para a Embed API?

Ela compartilha o limite de 60 requisições por minuto por chave com a Send API, além da própria cota mensal dedicada de chamadas por plano — zero no Free/Starter, igual à forma como a Send API transacional é limitada nesses níveis.

Isso funciona para um webinar com inscrição pública, não só um incorporado no app?

Os dois — um webinar pode continuar aberto para qualquer pessoa se inscrever pela própria página hospedada do MailInApp, usar a Embed API para inscrição incorporada no app, ou os dois ao mesmo tempo; a API só força o modo de inscrição em vez de acesso aberto.

Documentação relacionada

Veja também

Construa isso no estúdio

Comece no plano gratuito — todos os blocos interativos e o motor de fallback completo estão incluídos em todos os planos.

Começar a criar grátis Ver todos os casos de uso