Configura la verificación por correo electrónico con SendGrid Email

El conector oficial de Logto para el servicio de correo electrónico SendGrid.

tip:

Esta guía asume que tienes un entendimiento básico de los Conectores de Logto. Para aquellos que no están familiarizados, por favor consulta la guía de Conectores para comenzar.

Comenzar

SendGrid (es decir, Twilio SendGrid) es una plataforma de comunicación para correos electrónicos transaccionales y de marketing. Podemos usar su función de envío de correos electrónicos para enviar un código de verificación.

Registrar cuenta de SendGrid

Crea una nueva cuenta en el sitio web de SendGrid. Puedes omitir este paso si ya tienes una cuenta.

Verificar remitentes

Ve a la página de consola de SendGrid e inicia sesión con tu cuenta de SendGrid.

Los remitentes indican las direcciones desde las cuales se enviará nuestro correo electrónico de código de verificación. Para enviar correos electrónicos a través del servidor de correo de SendGrid, necesitas verificar al menos un remitente.

Desde la página de consola de SendGrid, ve a "Settings" -> "Sender Authentication" desde la barra lateral.

La autenticación de dominio es recomendada pero no obligatoria. Puedes hacer clic en "Get started" en la tarjeta "Authenticate Your Domain" y seguir la guía que aparece para vincular y verificar un remitente en SendGrid.

Al hacer clic en el botón "Verify a Single Sender" en el panel, ahora te enfocarás en un formulario que requiere información crítica para crear un remitente. Sigue la guía, completa todos estos campos y presiona el botón "Create".

Después de crear el remitente único, se debería enviar un correo electrónico con un enlace de verificación a la dirección de correo electrónico de tu remitente. Ve a tu buzón, encuentra el correo de verificación y termina de verificar el remitente único haciendo clic en el enlace proporcionado en el correo electrónico. Ahora puedes enviar correos electrónicos a través del conector de SendGrid usando el remitente que acabas de verificar.

Crear claves de API

Comencemos desde la página de consola de SendGrid, ve a "Settings" -> "API Keys" desde la barra lateral.

Haz clic en "Create API Key" en la esquina superior derecha de la página de API Keys. Escribe el nombre de la clave de API y personaliza "API Key Permission" según tu caso de uso. Se requiere un acceso global Full Access o Restricted Access con acceso completo a Mail Send antes de enviar correos electrónicos con esta clave de API.

La clave de API se te presenta en la pantalla tan pronto como terminas el proceso de Create API Key. Debes guardar esta clave de API en un lugar seguro porque esta es la única oportunidad que tienes para verla.

Configurar tu conector

Completa el campo apiKey con la clave de API creada en la sección "Crear claves de API".

Completa los campos fromEmail y fromName con la From Address y el Nickname de los remitentes. Puedes encontrar los detalles del remitente en la página "Sender Management". fromName es OPCIONAL, por lo que puedes omitirlo.

Puedes agregar múltiples plantillas de conector de correo de SendGrid para diferentes casos. Aquí tienes un ejemplo de cómo agregar una sola plantilla:

• Completa el campo subject, que funciona como el título de los correos electrónicos.
• Completa el campo content con contenidos de tipo cadena arbitraria. No olvides dejar el marcador de posición {{code}} para el código de verificación aleatorio.
• Completa el campo usageType con Register, SignIn, ForgotPassword, Generic para diferentes casos de uso.
• Completa el campo type con text/plain o text/html para diferentes tipos de contenido.

Para habilitar flujos completos de usuario, se requieren plantillas con usageType Register, SignIn, ForgotPassword y Generic.

Aquí tienes un ejemplo de JSON de plantilla de conector de SendGrid.

[
  {
    "subject": "<register-template-subject>",
    "content": "<Logto: Your verification code is {{code}}. (register template)>",
    "usageType": "Register",
    "type": "text/plain",
  },
  {
    "subject": "<sign-in-template-subject>",
    "content": "<Logto: Your verification code is {{code}}. (sign-in template)>",
    "usageType": "SignIn",
    "type": "text/plain",
  },
  {
    "subject": "<forgot-password-template-subject>",
    "content": "<Logto: Your verification code is {{code}}. (forgot-password template)>",
    "usageType": "ForgotPassword",
    "type": "text/plain",
  },
  {
    "subject": "<generic-template-subject>",
    "content": "<Logto: Your verification code is {{code}}. (generic template)>",
    "usageType": "Generic",
    "type": "text/plain",
  },
]

Probar el conector de correo electrónico de SendGrid

Puedes escribir una dirección de correo electrónico y hacer clic en "Send" para ver si la configuración funciona antes de "Save and Done".

Eso es todo. No olvides habilitar el conector en la experiencia de inicio de sesión

Tipos de configuración

Nombre	Tipo
apiKey	string
fromEmail	string
fromName	string (OPCIONAL)
templates	Template[]

Propiedades de la plantilla	Tipo	Valores del enum
subject	string	N/A
content	string	N/A
usageType	enum string	'Register' | 'SignIn' | 'ForgotPassword' | 'Generic'
type	enum string	'text/plain' | 'text/html'