Envie códigos de verificação por SMS para autenticação de dois fatores e segurança.
A API Verify do OneSignal permite que você envie códigos de verificação para usuários via SMS, sendo ideal para autenticação de dois fatores, registro de conta e redefinição de senha.
Crie um serviço de verificação Faça uma solicitação ao endpoint de criar serviço de verificação e forneça um FriendlyName. O nome amigável deve ser uma string descritiva que você cria para descrever o serviço de verificação. Este é o nome usado no SMS enviado ao usuário final. (por exemplo, Seu código de verificação [FriendlyName] é: XXXXXX) Pode ter até 32 caracteres. Este valor não deve conter PII. Opcionalmente, você também pode fornecer estes parâmetros adicionais:
CodeLength O comprimento do código de verificação a ser gerado. Deve ser um valor inteiro entre 4 e 10, inclusive.
LookupEnabled: Se deve realizar uma consulta com cada verificação iniciada e retornar informações sobre o número de telefone
SkipSMSToLandlines: Se deve pular o envio de verificações SMS para telefones fixos. Requer lookup_enabled.
Psd2Enabled: Se deve passar parâmetros de transação PSD2 ao iniciar uma verificação.
DoNotShareWarningEnabled: Se deve adicionar um aviso de segurança no final do corpo da verificação SMS. Desabilitado por padrão e aplica-se apenas a SMS. Exemplo de corpo de SMS: Seu código de verificação AppName é: 1234. Não compartilhe este código com ninguém; nossos funcionários nunca pedirão o código
CustomCodeEnabled: Se deve permitir o envio de verificações com um código personalizado em vez de um gerado aleatoriamente.
Totp.Issuer: Configuração opcional para os fatores TOTP. Defina o Emissor TOTP para este serviço. Isso permitirá configurar o emissor do URI TOTP. Padrão para o nome amigável do serviço se não fornecido.
Totp.TimeStep: Configuração opcional para os fatores TOTP. Define com que frequência, em segundos, os códigos TOTP são gerados. ou seja, um novo código TOTP é gerado a cada time_step segundos. Deve estar entre 20 e 60 segundos, inclusive. Padrão para 30 segundos
Totp.CodeLength: Configuração opcional para os fatores TOTP. Número de dígitos para códigos TOTP gerados. Deve estar entre 3 e 8, inclusive. Padrão para 6
Totp.Skew: Configuração opcional para os fatores TOTP. O número de passos de tempo, passado e futuro, que são válidos para validação de códigos TOTP. Deve estar entre 0 e 2, inclusive. Padrão para 1 Nota: por padrão, a mensagem para o usuário final dirá “Seu código de verificação [nome amigável] é: XXXXXX”. Para personalizar este idioma, entre em contato com o suporte.
Envie um código de verificação Faça uma solicitação ao endpoint de criar verificação. Forneça o número de telefone do usuário e o canal (SMS) que você deseja usar. Isso enviará o código de verificação ao usuário.
Verifique o código de verificação Faça uma solicitação ao endpoint de verificação de código. Forneça o número de telefone do usuário e o código de verificação enviado pelo usuário que você deseja verificar.
Considerações Adicionais
Tempo de Expiração: padrão é 10 minutos (entre em contato com o suporte para personalizar a expiração)
Tentativas: Certifique-se de considerar a experiência do usuário para tentativas de verificação falhadas e novas tentativas.
Segurança: Implemente melhores práticas para lidar com informações confidenciais como números de telefone e códigos de verificação.
