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

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

astuce:

Ce guide suppose que vous avez une compréhension de base des Connecteurs Logto. Pour ceux qui ne sont pas familiers, veuillez vous référer au guide des 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 possédez déjà un compte.

Vérifier les expéditeurs

Rendez-vous sur la page de 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é. Afin d'envoyer des e-mails via le serveur de messagerie SendGrid, vous devez vérifier au moins un expéditeur.

Depuis la page de 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 pour lier et vérifier un expéditeur à SendGrid.

En cliquant sur le bouton "Verify a Single Sender" dans le panneau, vous accédez à un formulaire nécessitant des informations essentielles pour créer un expéditeur. Suivez le guide, remplissez tous les champs et cliquez sur le bouton "Create".

Après la création de l'expéditeur unique, un e-mail contenant un lien de vérification sera envoyé à l'adresse e-mail de votre expéditeur. Rendez-vous 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 fourni 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 depuis la page de 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. Saisissez le nom de la clé API et personnalisez les "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 sauvegarder cette clé API dans un endroit sûr car c'est la seule occasion où vous pourrez la voir.

Configurer votre connecteur

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

Renseignez les champs fromEmail et fromName avec l’adresse d’expéditeur et le surnom de l’expéditeur. Vous pouvez trouver les détails de l’expéditeur sur la page "Sender Management". fromName est OPTIONNEL, vous pouvez donc le laisser vide.

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

• Renseignez le champ subject, qui sert de titre aux e-mails.
• Renseignez le champ content avec un contenu de type chaîne de caractères arbitraire. N'oubliez pas de laisser l’espace réservé {{code}} pour le code de vérification aléatoire.
• Renseignez le champ usageType avec Register, SignIn, ForgotPassword, Generic selon les différents cas d’utilisation.
• Renseignez le champ type avec text/plain ou text/html selon le type de contenu.

Pour activer tous les parcours utilisateur, 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: Votre code de vérification est {{code}}. (modèle d'inscription)>",
    "usageType": "Register",
    "type": "text/plain",
  },
  {
    "subject": "<sign-in-template-subject>",
    "content": "<Logto: Votre code de vérification est {{code}}. (modèle de connexion)>",
    "usageType": "SignIn",
    "type": "text/plain",
  },
  {
    "subject": "<forgot-password-template-subject>",
    "content": "<Logto: Votre code de vérification est {{code}}. (modèle mot de passe oublié)>",
    "usageType": "ForgotPassword",
    "type": "text/plain",
  },
  {
    "subject": "<generic-template-subject>",
    "content": "<Logto: Votre code de vérification est {{code}}. (modèle générique)>",
    "usageType": "Generic",
    "type": "text/plain",
  },
]

Tester le connecteur e-mail SendGrid

Vous pouvez saisir une adresse e-mail et cliquer sur "Send" pour vérifier si les paramètres fonctionnent avant de cliquer sur "Save and Done".

C’est tout. N’oubliez pas de Activer le connecteur pour l’inscription et la connexion.

Types de configuration

Nom	Type
apiKey	string
fromEmail	string
fromName	string (OPTIONNEL)
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'