Configurar verificação SMS com Aliyun Short Message Service

O conector oficial do Logto para o serviço de mensagens curtas da Aliyun.

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

Aliyun é um provedor de serviços em nuvem primário na Ásia, oferecendo muitos serviços em nuvem, incluindo SMS (serviço de mensagens curtas). O Aliyun SMS Connector é um plugin fornecido pela equipe Logto para chamar o serviço SMS da Aliyun, com a ajuda do qual os usuários finais do Logto podem se registrar e fazer login em sua conta Logto via código de verificação SMS.

Configurar um serviço de mensagens curtas no Console SMS da Aliyun

💡 Dica

Você pode pular algumas seções se já as tiver concluído.

Criar uma conta Aliyun

Vá para o site da Aliyun e registre sua conta Aliyun se você não tiver uma.

Ativar e Configurar o Aliyun Short Message Service

1. Faça login com sua conta Aliyun no site da Aliyun e vá para a página do console do serviço SMS.
2. Clique no botão "Open for free" (免费开通) no canto superior esquerdo da página do serviço SMS e comece o processo de configuração.
3. Leia e concorde com o "SMS service activation Agreement" (短信服务开通条款) e clique em "Subscribe to a service" (开通服务) para prosseguir.
4. Agora você está na página do console do serviço SMS, vá para "Mainland China" (国内消息) ou "Outside Mainland China" (国际/港澳台消息) no menu lateral conforme seu caso de uso.
5. Adicione assinatura e modelo seguindo as diretrizes e forneça os materiais ou informações necessárias para revisão.
   • Lembre-se de selecionar "Verification Code Message" (验证码) como "Scenario" (适用场景) ao preencher a aplicação de assinatura e também "Verification Code Message" (验证码) para "Type" (模板类型) ao solicitar uma revisão de modelo, pois estamos usando essas assinaturas e modelos para enviar código de verificação. Atualmente, não suportamos o envio de mensagens SMS além de mensagens de texto relacionadas a códigos de verificação.
   • Além disso, use {{code}} como um espaço reservado onde você deseja colocar seu código de verificação digital no conteúdo do modelo.
6. Após enviar sua aplicação de assinatura e modelo SMS, você precisará esperar que ela entre em vigor. Neste ponto, podemos voltar para a página do console do serviço SMS e enviar um SMS de teste. Se suas assinaturas e modelos estiverem prontos para uso, você pode testá-los diretamente; se ainda não estiverem em vigor, a Aliyun também fornece modelos de teste.
   • Você pode precisar recarregar uma pequena quantia de dinheiro antes de enviar mensagens de teste.
   • Você também pode ser solicitado a vincular um número de telefone de teste antes de enviar mensagens de teste. Para mais detalhes, vá para a guia "Quick Start" (快速学习) no menu lateral da página do console do serviço SMS.

Compor o JSON do conector

1. Na página do console do serviço SMS, passe o mouse sobre seu avatar no canto superior direito e vá para "AccessKey Management" (AccessKey 管理), e clique em "Create AccessKey" (创建 AccessKey). Você obterá um par "AccessKey ID" e "AccessKey Secret" após concluir a verificação de segurança. Por favor, mantenha-os adequadamente.
2. Vá para a guia "Mainland China" (国内消息) ou "Outside Mainland China" (国际/港澳台消息) que você acabou de visitar, você pode encontrar facilmente "Signature" (签名名称) e "Template Code" (模板 CODE).
   • Se você quiser usar a assinatura e o modelo apenas para teste, vá para a guia "Quick Start" (快速学习) e você os encontrará abaixo de "Signature & Templates (For Test Only)".
3. Preencha as configurações do Aliyun SMS Connector:
   • Preencha os campos accessKeyId e accessKeySecret com os pares de chave de acesso que você obteve no passo 1.
   • Preencha o campo signName com "Signature" (签名名称) mencionado no passo 2. Todos os modelos compartilharão este nome de assinatura.
   • Você pode adicionar vários modelos de conector SMS para diferentes casos. Aqui está um exemplo de adição de um único modelo:
     • Preencha o campo templateCode, que é como você pode controlar o contexto do SMS, com "Template Code" (模板 CODE) do passo 2.
     • Preencha o campo usageType com Register, SignIn, ForgotPassword ou Generic para diferentes casos de uso. (usageType é uma propriedade do Logto para identificar o caso de uso adequado.) Para habilitar fluxos de usuário completos, são necessários modelos com usageType Register, SignIn, ForgotPassword e Generic.

Testar o conector SMS da Aliyun

Você pode digitar um número de telefone 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
accessKeyId	string
accessKeySecret	string
signName	string
templates	Template[]

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

Referências

• Aliyun SMS - Quick Start