Suscripción por correo
Conecta Resend, Mailchimp, Kit, Loops, beehiiv, Brevo o SendGrid para capturar suscripciones por correo desde tus docs en la audiencia de tu proveedor.
Jamdesk puede recopilar direcciones de correo electrónico desde tu sitio de documentación y añadirlas directamente al proveedor de correo que ya usas. No hay ningún servicio de formularios de terceros de por medio. Conecta un proveedor una vez en el dashboard y luego coloca un formulario de suscripción en cualquier página. Tú eres dueño de la lista y del envío; Jamdesk solo captura la dirección y se la entrega a tu proveedor.
Las capturas de pantalla muestran la interfaz en inglés.
Requisitos previos
- Una cuenta con uno de los proveedores compatibles
- Una clave API de ese proveedor con permiso para añadir contactos
- El identificador de audiencia que la mayoría de los proveedores usan para elegir una lista (Audience ID, List ID, Form ID o Publication ID)
Cómo funciona la captura
Cuando conectas un proveedor, Jamdesk valida la clave API con la API de ese proveedor antes de guardarla. A partir de ahí, cada envío de formulario en tu sitio de documentación llama al proveedor y añade al lector a tu audiencia. Los envíos tienen un límite de frecuencia por visitante y por proyecto para bloquear abusos, y un campo honeypot oculto filtra los bots.
Así es como ven tus lectores un formulario de suscripción:
Puedes ver uno en funcionamiento en el changelog de Jamdesk.
Tu clave API se almacena en el backend de Jamdesk y se usa únicamente para añadir contactos. Nunca se escribe en tu sitio publicado, en tu docs.json ni en ningún código del lado del cliente, por lo que los visitantes no pueden leerla.
Proveedores compatibles
Siete proveedores capturan suscripciones de forma nativa. Los lectores envían un formulario alojado por Jamdesk y llegan a tu audiencia sin salir de tu documentación:
| Proveedor | Qué conectas |
|---|---|
| Resend | Clave API (acceso completo) + Audience ID |
| Mailchimp | Clave API (termina con tu datacenter, por ejemplo -us21) + Audience (List) ID |
| Kit (ConvertKit) | Clave API v4 + Form ID |
| Loops | Clave API |
| beehiiv | Clave API + Publication ID |
| Brevo | Clave API v3 + Contact List ID |
| SendGrid | Clave API con acceso de escritura a Marketing Contacts + Marketing List ID |
Otros dos proveedores son solo de inserción. Jamdesk muestra su propio formulario o iframe en lugar de capturar la dirección directamente, por lo que no se necesita ninguna clave:
| Proveedor | Qué proporcionas |
|---|---|
| Buttondown | El username de tu cuenta (en la etiqueta <EmailSubscribe>) |
| Substack | El username de tu cuenta (en la etiqueta <EmailSubscribe>) |
Consulta EmailSubscribe para la configuración solo de inserción.
Conectar un proveedor
En el dashboard, abre tu proyecto y ve a Integrations. Busca la tarjeta Email Signups.
Elige un proveedor en el menú desplegable Provider. El formulario se actualiza para pedir exactamente los campos que ese proveedor necesita, con un enlace a dónde encontrar su clave API.
Introduce la clave API y, para la mayoría de los proveedores, el identificador de audiencia (Loops solo necesita la clave). El campo de la clave está enmascarado.
Haz clic en Connect. Jamdesk valida la clave con tu proveedor antes de guardarla. Si la clave es incorrecta o carece de permisos de contacto, verás un error y no se guardará nada.
Una vez conectada, la tarjeta muestra una insignia Configured con tu proveedor y el ID de audiencia. Las nuevas publicaciones de tu documentación muestran formularios de captura en vivo.
Personalizar el texto del formulario
La tarjeta tiene dos campos opcionales, Form title y Form subtitle, que definen el título y la línea de apoyo en los formularios colocados automáticamente. Déjalos en blanco y el formulario mostrará solo el campo y el botón; complétalos y los formularios de changelog los recogerán en la siguiente publicación; no hace falta editar docs.json.
Puedes cambiar este texto en cualquier momento. Edita los campos en una tarjeta conectada y haz clic en Save copy; no necesitas volver a introducir tu clave API para hacerlo. Un title o una description definidos directamente en docs.json o en una etiqueta <EmailSubscribe> siguen prevaleciendo sobre el texto del dashboard, de modo que las anulaciones por página siguen funcionando.
Añadir un formulario a tu documentación
Conectar un proveedor no coloca un formulario por sí solo. Tú eliges dónde aparecen las suscripciones:
- Escribe
<EmailSubscribe provider="resend" />(usando el id de tu proveedor conectado) en cualquier página. - O coloca automáticamente un formulario en cada página de changelog configurando
placement: changelogendocs.json.
Ambos caminos se explican en la página del componente EmailSubscribe.
Desconectar un proveedor
Para dejar de recopilar suscripciones, abre la tarjeta Email Signups y haz clic en Remove. Los formularios dejan de capturar en tu siguiente publicación.
Desconectar elimina la clave solo de Jamdesk. Los suscriptores que ya recopilaste permanecen en la audiencia de tu proveedor. Jamdesk nunca los elimina. Puedes volver a conectarte en cualquier momento.