--- title: "Guia inicial rápido de senha de uso único" slug: "one-time-password-quick-start-guide" updated: 2026-06-12T10:30:57Z published: 2026-06-12T10:30:57Z canonical: "docs.xtremepush.com/one-time-password-quick-start-guide" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.xtremepush.com/llms.txt > Use this file to discover all available pages before exploring further. # Guia inicial rápido de senha de uso único Tudo o que você precisa saber antes de configurar e enviar senhas de uso único Uma senha de uso único (OTP) é usada para autenticação segura do usuário. Ele fornece um código temporário e único para verificar identidade durante login, transações ou outras operações sensíveis, aumentando a proteção contra acessos não autorizados. Atualmente, os OTPs são suportados apenas via SMS. ## Principais Recursos 1. **Geração e Entrega de OTP:** Gerar senhas de uso único e entregá-las aos números de celular dos usuários via SMS. 2. **Verificação:** Valide os códigos OTP fornecidos pelos usuários contra a solicitação original. 3. **Fila Dedicada**: Garante que as mensagens OTP sejam priorizadas em relação às comunicações de marketing para entrega rápida. 4. **Personalização**: Configure o tipo de OTP (numérico ou alfanumérico), duração e tempo de validade. 5. **Reportagem em Tempo Real:** Acesse logs e relatórios de entrega para visibilidade total. 6. **Autorização da API:** Endpoints OAuth protegidos para integração perfeita. ## Casos de Uso - Autenticação do Usuário: Melhore a segurança do login exigindo verificação por OTP. - Segurança Transacional: Confirme transações de alto valor ou sensíveis. - Recuperação de Conta: Simplifique e proteja os processos de redefinição de senha. > [!NOTE] > Pré-requisitos para Configurar Senhas de Uso Único (OTP) > > - **Gateway Ativo de SMS**: Confirme com seu Gestor de Conta que sua configuração de SMS está configurada para suportar funcionalidades OTP. > - **Números de Celular no Formato E.164:** Forneça números de celular destinatários no formato padronizado internacionalmente E.164: código de discagem internacional (sem incluir zeros 00 prefixados) seguido pelo número móvel (sem incluir zero 0 prefixado). (por exemplo, `353850123456`). > - [**Credenciais API**](/documentation/docs/pt-br/one-time-password): Obtenha [credenciais válidas OAuth 2.0](/documentation/docs/pt-br/oauth20) para autenticação se estiver usando endpoints API para geração e verificação de OTP. ## Começando com a integração de senhas de uso único O primeiro passo para usar o recurso OTP é ativar e configurar a integração OTP navegando até **Configurações → Integrações → Marketplace**, selecionando a integração OTP e **clicando em Conectar Novo**. As instruções completas podem ser [encontradas aqui](/documentation/docs/pt-br/one-time-password). Na Integração com o Marketplace, você pode ativar e configurar o recurso de Senha Única (OTP), personalizar configurações como tipo, duração e duração do OTP, e criar conteúdo por SMS. ## Configure as APIs OTP - Gerar OTP: Configure o `/otp/generate` endpoint para criar e enviar OTPs para seus usuários. Veja [OTP Generate](https://docs.xtremepush.com/reference/otp-generate) para a documentação de referência da API. - Envie OTP pré-determinado: Configure o `/otp/execute` endpoint para enviar seus próprios OTPs aos seus usuários. Veja [OTP Execute](https://docs.xtremepush.com/v2025.5/reference/otp-execute) para a documentação de referência da API. - Verificar OTP: Configure o `/otp/verify` endpoint para validar os OTPs inseridos pelos usuários. Veja [o OTP Verify](https://docs.xtremepush.com/reference/otp-verify) para a documentação de referência da API. Durante a configuração da API, você deve colocar os IPs na lista branca para garantir uma comunicação segura entre seus sistemas e o Xtremepush. ## Revisão de Logs e Solução de Problemas Verifique a aba de Histórico do OTP para logs relacionados à geração, entrega e verificação para garantir o funcionamento adequado. Navegue até **Configurações > Integrações > aba Histórico de Senha Única >** na plataforma Xtremepush. Use a funcionalidade de busca para filtrar registros por: **ID de perfil**: Identifique usuários específicos vinculados às atividades do OTP. **Data do Pedido**: Localize logs para um período específico. **ID OTP**: Rastreie um histórico único de OTP. **Tipo e Valor do Identificador**: Encontre registros usando identificadores específicos do usuário (por exemplo, user_id, customer_id ou e-mail)._ Examine as colunas para obter informações-chave: **Carimbo de Tempo da Solicitação**: *Quando o OTP foi gerado*. **Enviado**: *Se o SMS OTP foi enviado com sucesso (Sim/Não).* **Carimbo de data verificado**: *Quando o OTP foi verificado com sucesso.* **Erro**: *Quaisquer erros encontrados durante a geração ou verificação. Clique no ícone ID de Perfil para navegar até o perfil de usuário associado para uma investigação mais aprofundada.* ### Códigos de Erro | Código de erro | Descrição | | --- | --- | | OTP_EXPIRED | O OTP excedeu seu período de validade e não é mais válido para verificação. | | OTP_INVALID | O usuário inseriu um OTP incorreto. | | RETRY_LIMIT_EXCEEDED | O máximo permitido de tentativas de retentativa para verificação OTP foi ultrapassado. | | DELIVERY_FAILED* | O SMS OTP não pôde ser entregue ao destinatário devido a problemas de rede ou números inválidos. * Somente quando recibos de entrega estiverem habilitados | ## Métodos de Exportação de Senha Única [Lista de Registros de Histórico OTP do Fetch:](https://docs.xtremepush.com/reference/otp-history-list) Recupere registros de histórico OTP com opções de filtragem e pedido. [Informações do histórico OTP do Fetch:](https://docs.xtremepush.com/reference/otp-history-info) Obtenha informações detalhadas para um registro específico do OTP. ## Exportação Automatizada de Histórico OTP Permite exportações programadas do histórico OTP via e-mail ou armazenamento de arquivos. ## Como configurar a exportação do histórico OTP 1. Navegar para: **Automações → Exportações → Crear/Editar Exportar** 2. Selecione o Tipo de Exportação: 1. No menu suspenso do Tipo de Dados, escolha "Histórico OTP" (disponível apenas se existir uma integração OTP ativa). 3. Prossiga com a configuração selecionando a Integração e o Segmento necessários. 4. Programe e salve a exportação para automatizar a recuperação de dados. Para mais detalhes sobre exportações de automação, consulte o [Guia de Automações.](/documentation/docs/pt-br/automated-exports) > [!WARNING] > Se uma integração OTP for removida, a exportação exibirá seu ID em vez do nome. ## FAQ - Senha de Uso Único (OTP) ### Perguntas Comuns **Qual é o prazo de validade dos OTPs?** O tempo de expiração padrão para OTPs pode ser configurado durante a configuração. Normalmente, varia de 5 a 15 minutos, dependendo das suas necessidades de segurança. **Mensagens OTP podem ser personalizadas?** Sim, mensagens OTP podem ser personalizadas na plataforma ao criar uma Integração OTP. Garanta que a mensagem permaneça clara e inclua o código OTP de forma proeminente! **O que acontece se a entrega do OTP falhar?** Se a entrega do OTP falhar, o sistema tenta novamente com base na configuração da sua política de retentativa. Se as tentativas falharem, você pode revisar o problema usando o histórico do OTP. **O OTP é sensível a maiúsculas e minúsculas?** Sim, o OTP é sensível a maiúsculas e minúsculas. Os usuários devem inserir o código exatamente como recebido, incluindo letras maiúsculas e minúsculas, para garantir a verificação bem-sucedida. **Como funciona a verificação de retentativas do OTP?** O número de tentativas permitidas de verificação OTP é definido pela configuração **Verification Tries** na integração OTP. Por exemplo, se o máximo de tentativas for definido para 5, o usuário tem 5 chances (1 tentativa inicial + 4 tentativas). Na sexta tentativa e depois*, a resposta da API será "Tentativas Excedidas", impedindo novas tentativas. **O que acontece se um usuário solicitar um novo OTP sem verificar o anterior?** Se um usuário solicitar um novo OTP sem verificar o anterior, o antigo OTP é imediatamente invalidado e um novo OTP é gerado. O usuário deve usar o OTP gerado mais recentemente para verificação. **Um usuário pode verificar um OTP expirado ou invalidado?** Não, os usuários não podem verificar um OTP expirado ou invalidado. Eles devem inserir o OTP gerado mais recentemente para concluir a verificação.