Configurar verificação SMS com Tencent Short Message Service

O conector oficial do Logto para o Tencent Short Message Service.

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

A Tencent Cloud é um dos principais provedores de serviços em nuvem na Ásia, oferecendo diversos serviços, incluindo SMS (serviço de mensagem curta).

O conector Tencent Short Message Service é uma integração oficial do Logto que ajuda os usuários finais a se registrarem ou fazerem login usando códigos de verificação por SMS.

Configurar um serviço de mensagem curta na Tencent Cloud

Criar uma conta Tencent Cloud

Acesse o site da Tencent Cloud e registre sua conta caso ainda não tenha uma.

Ativar e configurar o Tencent Cloud SMS

1. Faça login com sua conta no site da Tencent Cloud e acesse a página do console do serviço SMS.
2. Clique no botão “Teste Gratuito” (免费试用) na página do serviço SMS e siga as etapas de configuração.
3. Concorde com os “Termos de Ativação do Serviço SMS” (短信开通服务条款) e clique em “Ativar Serviço” (开通服务) para prosseguir.
4. No “Visão Geral do Console SMS” (短信服务控制台概览), escolha “Mensagens Domésticas”(国内消息) ou “Mensagens Internacionais/Hong Kong, Macau, Taiwan”(国际/港澳台消息) na barra lateral conforme sua necessidade.
5. Adicione uma assinatura e um modelo para as mensagens SMS. Observações:
   • Ao adicionar uma “Assinatura” (签名), selecione “Código de Verificação” (验证码) no campo "Cenários Aplicáveis" (模版类型).
   • Ao adicionar um modelo, escolha “Código de Verificação” como tipo de modelo.
   • Inclua um placeholder {1} no conteúdo do modelo, que será substituído por um código gerado aleatoriamente.
   • Modelos com múltiplos placeholders não são suportados. Use ou crie um modelo com apenas um placeholder.
6. Envie a assinatura e o modelo para aprovação. Após o envio:
   • Aguarde até que entrem em vigor.
   • O teste de SMS pode ser feito a partir do “Visão Geral do Console SMS” (短信服务控制台概览). Assinaturas e modelos aprovados podem ser usados diretamente para teste, ou utilize os modelos de teste fornecidos caso ainda estejam em análise.
   • Certifique-se de que sua conta tenha saldo suficiente para testes e pré-cadastre o número de telefone de teste para receber o SMS com sucesso.

Para orientações detalhadas, clique na guia “Guia de Introdução” (新手配置指引) na Visão Geral do Console SMS.

Compor o JSON do conector

1. Acesse o “Visão Geral do Console SMS” e passe o mouse sobre seu avatar no canto superior direito. Navegue até “Gerenciamento de Acesso > Chaves de Acesso > Chaves de API” para gerar seu AccessKey ID e AccessKey Secret após concluir a verificação de segurança. Guarde-os adequadamente.
2. Na aba “Mensagens Domésticas” (国内消息) ou “Mensagens Internacionais/Hong Kong, Macau, Taiwan” (国际/港澳台消息), recupere o “Nome da Assinatura” (签名名称) e o “Código do Modelo” (模版 CODCE).
   • Para modelos de teste, verifique a guia “Introdução Rápida” (快速开始) em "Modelos Exclusivos para Teste" (测试专用签名模版).

• Configure o Conector Tencent Cloud SMS com os seguintes campos:
  • accessKeyId e accessKeySecret: Use as credenciais do passo 1.
  • signName: O nome da assinatura obtido no passo 2. Isso se aplica a todos os modelos.
  • Adicione vários modelos para diferentes cenários, se necessário. Exemplo para um único modelo:
    • templateCode: Obtido do “Código do Modelo” no passo 2.
    • usageType: Especifique um dos valores Register, SignIn, ForgotPassword ou Generic para diferentes cenários (propriedade específica do Logto).
    • Certifique-se de que os modelos estejam configurados para todos os quatro cenários para completar o fluxo.
  • sdkAppId: Encontrado em “Gerenciamento de Aplicativos” (应用管理).
  • region: Especifique a região suportada conforme a “Documentação de Envio” (发送文档).

Testar o conector Tencent Cloud SMS

Você pode digitar um número de telefone e clicar em "Enviar" para verificar se as configurações funcionam antes de clicar em "Salvar e Concluir".

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

Tipos de configuração

Nome	Tipo
accessKeyId	string
accessKeySecret	string
signName	string
region	string
sdkAppId	string
templates	Template[]

Propriedades do Template	Tipo	Valores enum
templateCode	string	N/A
usageType	enum string	'Register' / 'SignIn' / 'ForgotPassword' / 'Generic'

Referências

Como implementar a função de código de verificação por SMS?