Configurer la vérification par e-mail avec SendGrid Email

Le connecteur officiel Logto pour le service d'e-mail SendGrid.

astuce

Dans ce guide, nous supposons que vous avez des connaissances de base sur les Connecteurs Logto. Si ce n'est pas le cas, consultez le guide Configurer les connecteurs pour commencer.

Commencer

SendGrid (c'est-à-dire Twilio SendGrid) est une plateforme de communication client pour les e-mails transactionnels et marketing. Nous pouvons utiliser sa fonction d'envoi d'e-mails pour envoyer un code de vérification.

Enregistrer un compte SendGrid

Créez un nouveau compte sur le site Web de SendGrid. Vous pouvez ignorer cette étape si vous avez déjà un compte.

Vérifier les expéditeurs

Allez sur la page de la console SendGrid et connectez-vous avec votre compte SendGrid.

Les expéditeurs indiquent les adresses à partir desquelles notre e-mail de code de vérification sera envoyé. Pour envoyer des e-mails via le serveur de messagerie SendGrid, vous devez vérifier au moins un expéditeur.

À partir de la page de la console SendGrid, allez dans "Settings" -> "Sender Authentication" depuis la barre latérale.

L'authentification de domaine est recommandée mais non obligatoire. Vous pouvez cliquer sur "Get started" dans la carte "Authenticate Your Domain" et suivre le guide à venir pour lier et vérifier un expéditeur à SendGrid.

En cliquant sur le bouton "Verify a Single Sender" dans le panneau, vous vous concentrez maintenant sur un formulaire nécessitant des informations critiques pour créer un expéditeur. Suivez le guide, remplissez tous ces champs et appuyez sur le bouton "Create".

Après la création de l'expéditeur unique, un e-mail avec un lien de vérification devrait être envoyé à l'adresse e-mail de votre expéditeur. Allez dans votre boîte de réception, trouvez l'e-mail de vérification et terminez la vérification de l'expéditeur unique en cliquant sur le lien donné dans l'e-mail. Vous pouvez maintenant envoyer des e-mails via le connecteur SendGrid en utilisant l'expéditeur que vous venez de vérifier.

Créer des clés API

Commençons par la page de la console SendGrid, allez dans "Settings" -> "API Keys" depuis la barre latérale.

Cliquez sur "Create API Key" dans le coin supérieur droit de la page des clés API. Tapez le nom de la clé API et personnalisez "API Key Permission" selon votre cas d'utilisation. Un accès global Full Access ou Restricted Access avec un accès complet à Mail Send est requis avant d'envoyer des e-mails avec cette clé API.

La clé API vous est présentée à l'écran dès que vous avez terminé le processus Create API Key. Vous devez enregistrer cette clé API quelque part en sécurité car c'est la seule chance que vous pouvez la voir.

Configurer votre connecteur

Remplissez le champ apiKey avec la clé API créée dans la section "Créer des clés API".

Remplissez les champs fromEmail et fromName avec l'adresse From Address et le Nickname des expéditeurs. Vous pouvez trouver les détails de l'expéditeur sur la page "Sender Management". fromName est OPTIONNEL, vous pouvez donc ignorer de le remplir.

Vous pouvez ajouter plusieurs modèles de connecteur de messagerie SendGrid pour différents cas. Voici un exemple d'ajout d'un modèle unique :

• Remplissez le champ subject, qui fonctionne comme le titre des e-mails.
• Remplissez le champ content avec des contenus de type chaîne arbitraire. N'oubliez pas de laisser l'espace réservé {{code}} pour le code de vérification aléatoire.
• Remplissez le champ usageType avec Register, SignIn, ForgotPassword, Generic pour différents cas d'utilisation.
• Remplissez le champ type avec text/plain ou text/html pour différents types de contenu.

Afin d'activer les flux utilisateur complets, les modèles avec usageType Register, SignIn, ForgotPassword et Generic sont requis.

Voici un exemple de JSON de modèle de connecteur 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",
  },
]

Tester le connecteur d'e-mail SendGrid

Vous pouvez taper une adresse e-mail et cliquer sur "Send" pour voir si les paramètres peuvent fonctionner avant "Save and Done".

C'est tout. N'oubliez pas de Activer le connecteur dans l'expérience de connexion

Types de configuration

Nom	Type
apiKey	string
fromEmail	string
fromName	string (OPTIONAL)
templates	Template[]

Propriétés du modèle	Type	Valeurs Enum
subject	string	N/A
content	string	N/A
usageType	enum string	'Register' | 'SignIn' | 'ForgotPassword' | 'Generic'
type	enum string	'text/plain' | 'text/html'