Iscrizioni email
Collega Resend, Mailchimp, Kit, Loops, beehiiv, Brevo o SendGrid per raccogliere iscrizioni email dalla documentazione nel pubblico del tuo provider.
Jamdesk raccoglie gli indirizzi email dal tuo sito di documentazione e li aggiunge al provider email che già utilizzi. Non serve alcun servizio di moduli di terze parti. Collega un provider una sola volta nel dashboard, poi aggiungi un modulo di iscrizione a qualsiasi pagina. La lista e l’invio restano sotto il tuo controllo. Jamdesk raccoglie l’indirizzo e lo trasmette al provider.
Gli screenshot mostrano l'interfaccia in inglese.
Prerequisiti
- Un account con uno dei provider supportati
- Una chiave API del provider con l’autorizzazione per aggiungere contatti
- L’identificatore del pubblico usato dalla maggior parte dei provider per selezionare una lista (Audience ID, List ID, Form ID o Publication ID)
Come funziona l'acquisizione
Jamdesk convalida la chiave API tramite l’API del provider prima di salvarla. Ogni invio del modulo sul tuo sito di documentazione chiama quindi il provider e aggiunge il lettore al tuo pubblico. Gli invii sono soggetti a limiti di frequenza per visitatore e per progetto. Un campo honeypot nascosto filtra i bot.
I lettori vedono un modulo come questo:
Puoi vedere un esempio attivo nel changelog di Jamdesk.
La tua chiave API è archiviata nel backend di Jamdesk e viene usata solo per aggiungere contatti. Non viene mai inserita nel sito pubblicato, nel tuo docs.json o in alcun codice lato client.
Provider supportati
Sette provider raccolgono le iscrizioni in modo nativo. I lettori inviano un modulo ospitato da Jamdesk e vengono aggiunti al tuo pubblico senza lasciare la documentazione:
| Provider | Cosa devi collegare |
|---|---|
| Resend | Chiave API (accesso completo) + Audience ID |
| Mailchimp | Chiave API (termina con il tuo datacenter, ad es. -us21) + Audience (List) ID |
| Kit (ConvertKit) | Chiave API v4 + Form ID |
| Loops | Chiave API |
| beehiiv | Chiave API + Publication ID |
| Brevo | Chiave API v3 + Contact List ID |
| SendGrid | Chiave API con accesso in scrittura a Marketing Contacts + Marketing List ID |
Altri due provider sono disponibili solo tramite incorporamento. Jamdesk visualizza il loro modulo o iframe invece di raccogliere l’indirizzo. Non serve alcuna chiave:
| Provider | Cosa devi fornire |
|---|---|
| Buttondown | Lo username del tuo account (nel tag <EmailSubscribe>) |
| Substack | Lo username del tuo account (nel tag <EmailSubscribe>) |
Consulta EmailSubscribe per la configurazione dei provider disponibili solo tramite incorporamento.
Collega un provider
Nel dashboard, apri il tuo progetto e vai a Integrations. Individua la scheda Email Signups.
Seleziona un provider dal menu a discesa Provider. Il modulo richiede quindi i campi necessari per quel provider e include un link che indica dove trovare la chiave API.
Inserisci la chiave API e, per la maggior parte dei provider, l’identificatore del pubblico (Loops richiede solo la chiave). Il campo della chiave è mascherato.
Fai clic su Connect. Jamdesk convalida la chiave con il provider prima di salvarla. Una chiave errata o priva delle autorizzazioni per gestire i contatti genera un errore. Non viene salvato nulla.
La scheda collegata mostra il badge Configured con il nome del provider e l’ID del pubblico. Alla successiva pubblicazione della documentazione verranno visualizzati i moduli di raccolta attivi.
Personalizza il testo del modulo
I campi facoltativi Form title e Form subtitle definiscono il titolo e la frase di accompagnamento dei moduli inseriti automaticamente. Se lasci i campi vuoti, il modulo mostra solo il campo email e il pulsante. I moduli del changelog utilizzano i campi compilati alla pubblicazione successiva, senza modifiche a docs.json.
Puoi modificare questi testi in qualsiasi momento. Aggiorna i campi in una scheda collegata e fai clic su Save copy. Non devi inserire di nuovo la chiave API. Un title o una description impostati in docs.json o in un tag <EmailSubscribe> sostituiscono i testi del dashboard.
Aggiungi un modulo alla documentazione
Collegare un provider non inserisce automaticamente un modulo. Scegli tu dove mostrare le iscrizioni:
- Scrivi
<EmailSubscribe provider="resend" />(usando l’ID del provider collegato) in qualsiasi pagina. - Oppure imposta
placement: changelogindocs.jsonper inserire automaticamente un modulo in ogni pagina del changelog.
La pagina del componente EmailSubscribe descrive queste opzioni.
Disconnetti un provider
Apri la scheda Email Signups e fai clic su Remove per interrompere la raccolta delle iscrizioni. I moduli smetteranno di raccogliere dati alla prossima pubblicazione.
Scollegando il provider rimuovi la chiave solo da Jamdesk. Gli iscritti già raccolti restano nel pubblico del provider. Jamdesk non li elimina mai. Puoi collegare di nuovo il provider in qualsiasi momento.