Documentation menu

Guía rápida

La Embed API permite que tu propio backend inscriba o registre a tus propios usuarios finales en un curso o webinar de MailInApp, e incruste la experiencia de visualización/unión en tu aplicación — sin que ese usuario final toque nunca una cuenta del panel de MailInApp. Comparte la misma clave de API tipo bearer que la API de envío transaccional — sin credencial nueva que crear.

Crea una clave

La misma clave que en cualquier otro lugar: bajo Desarrolladores en el panel, pulsa Crear clave. La clave completa — mia_live_... — se muestra exactamente una vez; MailInApp solo conserva un hash. Una clave puede llamar a cada ruta de tu cuenta, incluidas las siguientes.

Registrar a un asistente de webinar

Registra a un usuario final en un webinar de registro público y devuelve un enlace de unión — sin formulario de MailInApp, sin cuenta de MailInApp para tu usuario:

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

Una llamada exitosa devuelve un enlace de unión confirmado o un estado de lista de espera:

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

Crea el webinar en sí de la misma forma — POST /api/v1/webinars — o reutiliza uno que ya creaste desde En vivo en el panel; en cualquier caso debe tener accessMode: "registration". Mira la referencia de la API para las formas completas de solicitud/respuesta.

Inscribir a un suscriptor de curso

Otorga (o revoca) acceso a un curso para una dirección de correo — tu propio sistema de facturación o pago decide quién tiene derecho de acceso, MailInApp solo renderiza el 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 }

Incrustar el reproductor del curso

Una vez que un suscriptor está inscrito, crea un token firmado de corta duración (5 minutos) y redirige el iframe o la ventana de tu aplicación a la URL devuelta:

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 inicia sesión al visitante en una página de arranque que canjea el token y lo lleva al mismo portal del curso — video, progreso, cuestionarios — que obtiene un suscriptor inscrito directamente. El curso debe estar published y la cuenta debe haber reclamado ya un slug de membresía (/learn/<slug>) para que esto tenga éxito.

El verdadero diferenciador: correos de ciclo de vida interactivos

Los correos de registro, recordatorio, inscripción y finalización se siguen enviando todos — por defecto, con el texto de confirmación plano de hoy. Desde el propio panel de configuración del curso o webinar en el panel de control, una nueva sección de Correos de ciclo de vida te permite apuntar cualquiera de esos eventos a un proyecto que construiste en el estudio en su lugar. El correo que se envía entonces se renderiza a través del motor de alternativas completo (bloques cinéticos, etiquetas de combinación, vista en vivo) en lugar de una cadena fija. Nada cambia para un evento que dejes sin vincular.

Próximos pasos

  • Formas completas de solicitud/respuesta, eventos de vinculación de ciclo de vida, límites de tasa y códigos de error: referencia de la API.
  • ¿No tienes un curso o webinar existente para inscribir/registrar? Crea uno primero desde Cursos o En vivo en el panel — la Embed API envuelve los mismos datos subyacentes, no crea un catálogo separado.
  • Los envíos transaccionales de texto libre o de proyecto del estudio siguen pasando por la API de envío — la Embed API es específicamente para la inscripción y la incrustación de cursos/webinars.