Configurar verificação de email com SendGrid Email

O conector oficial do Logto para o serviço de email SendGrid.

dica

Neste guia, assumimos que você tem conhecimento básico sobre Conectores (Connectors) do Logto. Se não tiver, confira o guia Configurar conectores para começar.

Introdução

SendGrid (ou seja, Twilio SendGrid) é uma plataforma de comunicação com o cliente para emails transacionais e de marketing. Podemos usar sua função de envio de email para enviar um código de verificação.

Registrar conta SendGrid

Crie uma nova conta no site do SendGrid. Você pode pular esta etapa se já tiver uma conta.

Verificar remetentes

Vá para a página do console do SendGrid e faça login com sua conta SendGrid.

Os remetentes indicam os endereços de onde nosso email de código de verificação será enviado. Para enviar emails via servidor de email do SendGrid, você precisa verificar pelo menos um remetente.

A partir da página do console do SendGrid, vá para "Settings" -> "Sender Authentication" na barra lateral.

A autenticação de domínio é recomendada, mas não obrigatória. Você pode clicar em "Get started" no cartão "Authenticate Your Domain" e seguir o guia que aparece para vincular e verificar um remetente no SendGrid.

Ao clicar no botão "Verify a Single Sender" no painel, você estará focando em um formulário que requer algumas informações críticas para criar um remetente. Siga o guia, preencha todos esses campos e clique no botão "Create".

Após o remetente único ser criado, um email com um link de verificação deve ser enviado para o endereço de email do seu remetente. Vá para sua caixa de entrada, encontre o email de verificação e conclua a verificação do remetente único clicando no link fornecido no email. Agora você pode enviar emails via conector SendGrid usando o remetente que acabou de verificar.

Criar API keys

Vamos começar a partir da página do console do SendGrid, vá para "Settings" -> "API Keys" na barra lateral.

Clique em "Create API Key" no canto superior direito da página de API Keys. Digite o nome da API key e personalize "API Key Permission" conforme seu caso de uso. Um Full Access global ou Restricted Access com acesso total ao Mail Send é necessário antes de enviar emails com esta API key.

A API Key é apresentada a você na tela assim que você termina o processo de Create API Key. Você deve salvar esta API Key em algum lugar seguro, pois esta é a única chance de vê-la.

Configurar seu conector

Preencha o campo apiKey com a API Key criada na seção "Criar API keys".

Preencha os campos fromEmail e fromName com o From Address e Nickname dos remetentes. Você pode encontrar os detalhes do remetente na página "Sender Management". fromName é OPCIONAL, então você pode pular o preenchimento.

Você pode adicionar vários modelos de conector de email SendGrid para diferentes casos. Aqui está um exemplo de adição de um único modelo:

• Preencha o campo subject, que funciona como o título dos emails.
• Preencha o campo content com conteúdos de string arbitrários. Não se esqueça de deixar o espaço reservado {{code}} para o código de verificação aleatório.
• Preencha o campo usageType com Register, SignIn, ForgotPassword, Generic para diferentes casos de uso.
• Preencha o campo type com text/plain ou text/html para diferentes tipos de conteúdo.

Para habilitar fluxos completos de usuário, são necessários modelos com usageType Register, SignIn, ForgotPassword e Generic.

Aqui está um exemplo de JSON de modelo de conector SendGrid.

[
  {
    "subject": "<register-template-subject>",
    "content": "<Logto: Seu código de verificação é {{code}}. (modelo de registro)>",
    "usageType": "Register",
    "type": "text/plain",
  },
  {
    "subject": "<sign-in-template-subject>",
    "content": "<Logto: Seu código de verificação é {{code}}. (modelo de login)>",
    "usageType": "SignIn",
    "type": "text/plain",
  },
  {
    "subject": "<forgot-password-template-subject>",
    "content": "<Logto: Seu código de verificação é {{code}}. (modelo de recuperação de senha)>",
    "usageType": "ForgotPassword",
    "type": "text/plain",
  },
  {
    "subject": "<generic-template-subject>",
    "content": "<Logto: Seu código de verificação é {{code}}. (modelo genérico)>",
    "usageType": "Generic",
    "type": "text/plain",
  },
]

Testar conector de email SendGrid

Você pode digitar um endereço de email e clicar em "Send" para ver se as configurações funcionam antes de "Save and Done".

É isso. Não se esqueça de Habilitar conector na experiência de login

Tipos de configuração

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

Propriedades do Template	Tipo	Valores do Enum
subject	string	N/A
content	string	N/A
usageType	enum string	'Register' | 'SignIn' | 'ForgotPassword' | 'Generic'
type	enum string	'text/plain' | 'text/html'