mailinapp
Documentation menu

Schnellstart

Die Embed API lässt Ihr eigenes Backend Ihre eigenen Endnutzer in einen MailInApp-Kurs oder ein Webinar einschreiben oder registrieren und bettet das Ansehen-/Beitreten-Erlebnis in Ihre App ein — ohne dass dieser Endnutzer jemals ein MailInApp-Dashboard-Konto berührt. Sie teilt sich denselben Bearer-API-Schlüssel wie die transaktionale Send API — keine neue Zugangsdaten auszustellen.

Einen Schlüssel ausstellen

Derselbe Schlüssel wie überall sonst: Klicken Sie unter Entwickler im Dashboard auf Schlüssel erstellen. Der vollständige Schlüssel — mia_live_... — wird genau einmal angezeigt; MailInApp behält nur einen Hash davon. Ein einzelner Schlüssel kann jede Route in Ihrem Konto aufrufen, einschließlich der unten genannten.

Einen Webinar-Teilnehmer registrieren

Registriert einen Endnutzer für ein Webinar mit öffentlicher Registrierung und gibt einen Beitritts-Link zurück — kein MailInApp-Formular, kein MailInApp-Konto für Ihren Nutzer:

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

Ein erfolgreicher Aufruf gibt entweder einen bestätigten Beitritts-Link oder einen Wartelisten-Status zurück:

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

Erstellen Sie das Webinar selbst auf dieselbe Weise — POST /api/v1/webinars — oder nutzen Sie eines wieder, das Sie bereits unter Live im Dashboard erstellt haben; in jedem Fall muss es accessMode: "registration" haben. Siehe die API-Referenz für die vollständigen Anfrage-/Antwortformen.

Einen Kurs-Abonnenten einschreiben

Gewährt (oder entzieht) Kurszugriff für eine E-Mail-Adresse — Ihr eigenes Abrechnungs- oder Checkout-System entscheidet, wer berechtigt ist, MailInApp rendert nur den Kurs:

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 }

Den Kurs-Viewer einbetten

Sobald ein Abonnent eingeschrieben ist, stellen Sie ein kurzlebiges (5-minütiges) signiertes Token aus und leiten Sie das iframe oder Fenster Ihrer App an die zurückgegebene 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=..." }

Das Öffnen von portalUrl meldet den Besucher auf einer Bootstrap-Seite an, die das Token einlöst und ihn im selben Kursportal landen lässt — Video, Fortschritt, Quizze — das ein direkt eingeschriebener Abonnent erhält. Der Kurs muss published sein, und das Konto muss bereits einen Mitgliedschafts-Slug (/learn/<slug>) beansprucht haben, damit dies gelingt.

Der eigentliche Differenzierungsfaktor: interaktive Lifecycle-E-Mails

Registrierungs-, Erinnerungs-, Einschreibungs- und Abschluss-E-Mails gehen weiterhin hinaus — standardmäßig mit dem heutigen schlichten Bestätigungstext. Über ein neues Panel Lifecycle-E-Mails im eigenen Einstellungsbereich des Kurses oder Webinars im Dashboard können Sie jedes dieser Ereignisse stattdessen auf ein von Ihnen im Studio gebautes Projekt richten. Die dann versandte E-Mail rendert durch die vollständige Fallback-Engine (kinetische Blöcke, Merge-Tags, Live-Ansicht) statt durch eine fest codierte Zeichenkette. Für ein nicht gebundenes Ereignis ändert sich nichts.

Nächste Schritte

  • Vollständige Anfrage-/Antwortformen, Lifecycle-Bindungsereignisse, Ratenlimits und Fehlercodes: API-Referenz.
  • Kein vorhandener Kurs oder Webinar, in den/das eingeschrieben/registriert werden kann? Erstellen Sie zunächst eines unter Kurse oder Live im Dashboard — die Embed API umhüllt dieselben zugrunde liegenden Daten, sie erstellt keinen separaten Katalog.
  • Freiform- oder Studio-Projekt-Transaktionsversände laufen weiterhin über die Send API — die Embed API ist speziell für Kurs-/Webinar-Einschreibung und -Einbettung.