Configurar verificação de email com SendGrid Email

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

dica:

Este guia assume que você tem um entendimento básico dos Conectores (Connectors) do Logto. Para aqueles que não estão familiarizados, consulte o guia de Conectores para começar.

Introdução

SendGrid (ou seja, Twilio SendGrid) é uma plataforma de comunicação 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 da SendGrid. Você pode pular esta etapa se já possui uma conta.

Verificar remetentes

Acesse a página do console da SendGrid e faça login com sua conta SendGrid.

Remetentes indicam os endereços dos quais nosso e-mail de código de verificação será enviado. Para enviar e-mails via servidor de e-mail SendGrid, você precisa verificar pelo menos um remetente.

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

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

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

Após criar o remetente individual, um e-mail com um link de verificação será enviado para o endereço de e-mail do remetente. Acesse sua caixa de entrada, encontre o e-mail de verificação e conclua a verificação do remetente clicando no link fornecido no e-mail. Agora você pode enviar e-mails via conector SendGrid usando o remetente que acabou de verificar.

Criar chaves de API

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

Clique em "Create API Key" no canto superior direito da página de chaves de API. Digite o nome da chave de API e personalize a "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 e-mails com esta chave de API.

A chave de API será apresentada na tela assim que você concluir o processo de Create API Key. Você deve salvar esta chave de API em um local seguro, pois esta é a única chance de visualizá-la.

Configurar seu conector

Preencha o campo apiKey com a chave de API criada na seção "Criar chaves de API".

Preencha os campos fromEmail e fromName com o From Address e Nickname dos remetentes. Você pode encontrar os detalhes do remetente na "Sender Management" page. O campo fromName é OPCIONAL, então você pode deixá-lo em branco.

Você pode adicionar vários modelos de conector de e-mail 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 e-mails.
• Preencha o campo content com conteúdos de texto 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 ou Generic para diferentes casos de uso.
• Preencha o campo type com text/plain ou text/html para diferentes tipos de conteúdo.

Para habilitar todos os fluxos 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 e-mail SendGrid

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

É isso. Não se esqueça de Habilitar o conector no cadastro e login.

Tipos de configuração

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

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