mailinapp
Documentation menu

Guida rapida

L'Embed API permette al tuo backend di iscrivere o registrare i tuoi utenti finali in un corso o webinar MailInApp, e di incorporare l'esperienza di visualizzazione/partecipazione nella tua app — senza che quell'utente finale tocchi mai un account dashboard MailInApp. Condivide la stessa Chiave API bearer della Send API transazionale — nessuna nuova credenziale da generare.

Genera una chiave

Stessa chiave di sempre: sotto Sviluppatori nella dashboard, premi Crea chiave. La chiave completa — mia_live_... — viene mostrata esattamente una volta; MailInApp conserva solo un hash. Una chiave può chiamare ogni rotta del tuo account, incluse quelle qui sotto.

Registrare un partecipante al webinar

Registra un utente finale per un webinar a registrazione pubblica e restituisce un link di partecipazione — nessun modulo MailInApp, nessun account MailInApp per il tuo utente:

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 chiamata riuscita restituisce un link di partecipazione confermato oppure uno stato in lista d'attesa:

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

Crea il webinar stesso nello stesso modo — POST /api/v1/webinars — oppure riusa uno che hai già creato da Live nella dashboard; in entrambi i casi deve avere accessMode: "registration". Vedi il riferimento API per le forme complete di richiesta/risposta.

Iscrivere un abbonato a un corso

Concede (o revoca) l'accesso al corso per un indirizzo email — il tuo stesso sistema di fatturazione o checkout decide chi ne ha diritto, MailInApp si limita a renderizzare il corso:

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 }

Incorporare il visualizzatore del corso

Una volta che un abbonato è iscritto, genera un token firmato di breve durata (5 minuti) e reindirizza l'iframe o la finestra della tua app all'URL restituito:

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

Aprire portalUrl autentica il visitatore su una pagina di bootstrap che riscatta il token e lo porta nello stesso portale del corso — video, avanzamento, quiz — che riceve un abbonato iscritto direttamente. Il corso deve essere published e l'account deve aver già rivendicato uno slug del portale dei membri (/learn/<slug>) perché questo abbia successo.

Il vero elemento differenziante: email di ciclo di vita interattive

Le email di registrazione, promemoria, iscrizione e completamento vengono comunque tutte inviate — per impostazione predefinita, con il testo di conferma semplice di oggi. Dal pannello delle impostazioni del corso o del webinar nella dashboard, una nuova sezione Email di ciclo di vita ti permette di puntare uno qualsiasi di questi eventi verso un progetto che hai costruito nello Studio invece che verso il testo prefissato. L'email che viene inviata allora si renderizza attraverso il motore di fallback completo (blocchi cinetici, tag di personalizzazione, vista live) invece che tramite una stringa scritta staticamente. Nulla cambia per un evento che lasci non associato.

Prossimi passi

  • Forme complete di richiesta/risposta, eventi di associazione al ciclo di vita, limiti di velocità e codici di errore: riferimento API.
  • Non hai un corso o un webinar esistente da iscrivere/registrare? Creane uno prima da Corsi o Live nella dashboard — l'Embed API avvolge lo stesso catalogo di dati sottostante, non ne crea uno separato.
  • Gli invii transazionali liberi o basati su progetti dello Studio passano ancora attraverso la Send API — l'Embed API serve specificamente per l'iscrizione e l'incorporazione di corsi/webinar.