Inscriptions par e-mail
Connectez Resend, Mailchimp, Kit, Loops, beehiiv, Brevo ou SendGrid pour collecter des inscriptions par e-mail depuis vos docs vers votre propre audience.
Jamdesk peut collecter des adresses e-mail depuis votre site de documentation et les ajouter directement au fournisseur d'e-mail que vous utilisez déjà. Aucun service de formulaire tiers ne s'intercale. Connectez un fournisseur une fois dans le dashboard, puis déposez un formulaire d'inscription sur n'importe quelle page. Vous possédez la liste et l'envoi ; Jamdesk se contente de capturer l'adresse et de la transmettre à votre fournisseur.
Prérequis
- Un compte chez l'un des fournisseurs pris en charge
- Une clé API de ce fournisseur avec la permission d'ajouter des contacts
- L'identifiant d'audience que la plupart des fournisseurs utilisent pour choisir une liste (Audience ID, List ID, Form ID ou Publication ID)
Fonctionnement de la capture
Lorsque vous connectez un fournisseur, Jamdesk valide la clé API auprès de l'API de ce fournisseur avant de l'enregistrer. Ensuite, chaque soumission de formulaire sur votre site de documentation appelle le fournisseur et ajoute le lecteur à votre audience. Les soumissions sont limitées en fréquence par visiteur et par projet pour bloquer les abus, et un champ honeypot caché filtre les bots.
Voici à quoi ressemble un formulaire d'inscription pour vos lecteurs :
Les captures d'écran montrent l'interface en anglais.
Vous pouvez en voir un en direct sur le changelog Jamdesk.
Votre clé API est stockée sur le backend de Jamdesk et utilisée uniquement pour ajouter des contacts. Elle n'est jamais écrite dans votre site publié, votre docs.json, ni dans aucun code côté client, elle ne peut donc pas être lue par les visiteurs.
Fournisseurs pris en charge
Sept fournisseurs capturent les inscriptions nativement. Les lecteurs soumettent un formulaire hébergé par Jamdesk et atterrissent dans votre audience sans quitter vos docs :
| Fournisseur | Ce que vous connectez |
|---|---|
| Resend | Clé API (accès complet) + Audience ID |
| Mailchimp | Clé API (se terminant par votre datacenter, ex. -us21) + Audience (List) ID |
| Kit (ConvertKit) | Clé API v4 + Form ID |
| Loops | Clé API |
| beehiiv | Clé API + Publication ID |
| Brevo | Clé API v3 + Contact List ID |
| SendGrid | Clé API avec accès en écriture Marketing Contacts + Marketing List ID |
Deux autres fournisseurs sont embed-only. Jamdesk affiche leur propre formulaire ou iframe plutôt que de capturer l'adresse lui-même, donc aucune clé n'est nécessaire :
| Fournisseur | Ce que vous fournissez |
|---|---|
| Buttondown | Votre username de compte (sur la balise <EmailSubscribe>) |
| Substack | Votre username de compte (sur la balise <EmailSubscribe>) |
Consultez EmailSubscribe pour la configuration embed-only.
Connecter un fournisseur
Dans le dashboard, ouvrez votre projet et allez dans Settings. Trouvez la carte Email Signups.
Sélectionnez un fournisseur dans le menu déroulant Provider. Le formulaire se met à jour pour demander exactement les champs dont ce fournisseur a besoin, avec un lien vers l'endroit où trouver sa clé API.
Entrez la clé API et, pour la plupart des fournisseurs, l'identifiant d'audience (Loops a besoin uniquement de la clé). Le champ de la clé est masqué.
Cliquez sur Connect. Jamdesk valide la clé auprès de votre fournisseur avant de l'enregistrer. Si la clé est incorrecte ou manque de permissions sur les contacts, une erreur s'affiche et rien n'est enregistré.
Une fois connecté, la carte affiche un badge Configured avec votre fournisseur et l'ID d'audience. Les nouvelles publications de vos docs affichent des formulaires de capture en direct.
Personnaliser le texte du formulaire
La carte comporte deux champs facultatifs, Form title et Form subtitle, qui définissent le titre et la ligne de soutien sur les formulaires placés automatiquement. Laissez-les vides et le formulaire affiche seulement le champ et le bouton ; remplissez-les et les formulaires du changelog les récupèrent à la prochaine publication ; aucune modification de docs.json n'est nécessaire.
Vous pouvez modifier ce texte à tout moment. Modifiez les champs sur une carte connectée et cliquez sur Save copy ; vous n'avez pas besoin de ressaisir votre clé API pour le faire. Un title ou une description définis directement dans docs.json ou sur une balise <EmailSubscribe> l'emportent toujours sur le texte du dashboard, de sorte que les surcharges par page continuent de fonctionner.
Ajouter un formulaire à vos docs
Connecter un fournisseur ne place pas de formulaire à lui seul. Vous choisissez où les inscriptions apparaissent :
- Écrivez
<EmailSubscribe provider="resend" />(en utilisant l'id de votre fournisseur connecté) sur n'importe quelle page. - Ou placez automatiquement un formulaire sur chaque page de changelog en définissant
placement: changelogdansdocs.json.
Les deux méthodes sont couvertes sur la page du composant EmailSubscribe.
Déconnecter un fournisseur
Pour arrêter de collecter les inscriptions, ouvrez la carte Email Signups et cliquez sur Remove. Les formulaires arrêtent de capturer à votre prochaine publication.
La déconnexion supprime la clé de Jamdesk uniquement. Les abonnés déjà collectés restent dans l'audience de votre fournisseur. Jamdesk ne les supprime jamais. Vous pouvez vous reconnecter à tout moment.