mailinapp
Documentation menu

Início rápido

A Embed API permite que seu próprio backend matricule ou inscreva seus próprios usuários finais em um curso ou webinar do MailInApp, e incorpore a experiência de visualização/participação no seu app — sem que esse usuário final chegue a tocar em uma conta do painel do MailInApp. Ela compartilha a mesma chave de API bearer da Send API transacional — nenhuma credencial nova para gerar.

Gere uma chave

A mesma chave de todo o resto: em Developers, no painel, clique em Create key. A chave completa — mia_live_... — é exibida exatamente uma vez; o MailInApp só guarda um hash. Uma chave pode chamar qualquer rota da sua conta, incluindo as abaixo.

Inscreva um participante de webinar

Inscreve um usuário final em um webinar de inscrição pública e retorna um link de acesso — sem formulário do MailInApp, sem conta do MailInApp para o seu usuário:

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"
  }'

Uma chamada bem-sucedida retorna um link de acesso confirmado ou um status de lista de espera:

{ "status": "confirmed", "joinUrl": "https://mailinapp.com/webinar/.../join?token=..." }

Crie o próprio webinar do mesmo jeito — POST /api/v1/webinars — ou reutilize um que você já criou em Live, no painel; de qualquer forma, ele precisa ter accessMode: "registration". Veja a referência da API para os formatos completos de requisição/resposta.

Matricule um(a) assinante de curso

Concede (ou revoga) o acesso a um curso para um endereço de e-mail — seu próprio sistema de cobrança ou checkout decide quem tem direito, o MailInApp só renderiza o curso:

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 }

Incorpore o visualizador do curso

Depois que um(a) assinante está matriculado(a), gere um token assinado de curta duração (5 minutos) e redirecione o iframe ou a janela do seu app para a URL retornada:

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=..." }

Abrir portalUrl autentica o visitante em uma página de inicialização que resgata o token e o leva ao mesmo portal de curso — vídeo, progresso, quizzes — que um(a) assinante matriculado(a) diretamente recebe. O curso precisa estar published e a conta já precisa ter reivindicado um slug de assinatura (/learn/<slug>) para que isso funcione.

O verdadeiro diferencial: e-mails de ciclo de vida interativos

Os e-mails de inscrição, lembrete, matrícula e conclusão continuam saindo — por padrão, com o texto de confirmação simples de hoje. No próprio painel de configurações do curso ou webinar, no painel de controle, uma nova seção Lifecycle emails permite apontar qualquer um desses eventos para um projeto que você construiu no estúdio. O e-mail que sai então é renderizado através do motor de fallback completo (blocos cinéticos, tags de personalização, visualização ao vivo) em vez de um texto fixo. Nada muda para um evento que você deixar sem vinculação.

Próximos passos

  • Formatos completos de requisição/resposta, eventos de vinculação de ciclo de vida, limites de taxa e códigos de erro: referência da API.
  • Não tem nenhum curso ou webinar existente para matricular/inscrever? Crie um primeiro em Courses ou Live, no painel — a Embed API encapsula os mesmos dados subjacentes, ela não cria um catálogo separado.
  • Envios transacionais livres ou baseados em projeto do estúdio continuam passando pela Send API — a Embed API é especificamente para matrícula/inscrição e incorporação de curso/webinar.