Conteúdo

  1. Visão Geral

  2. Configuração

  3. Como enviar código de acesso para o usuário

  4. Como redefinir a senha

  5. Como modificar template do e-mail
  6. Como adicionar URL com código de acesso no e-mail


01. Visão geral

.......

....

.....

,,,,

02. Configuração


A recuperação de senha deve estar ativa no produto.

Configuração no DATASUL: É habilitada por meio da propriedade enable.recover.password, para mais informações sobre a propriedade, acesse Documentação "datasul_framework.properties". 

Configuração no DATASUL FOR THF: É habilitada nas Propriedades do Sistema, para mais informações sobre a propriedade, acesse Segurança. 

Caso a recuperação de senha não esteja ativa, será retornada mensagem de ERRO.

Mensagem no DATASUL




Mensagem no DATASUL FOR THF

Verifique se os parâmetros de e-mail estão configurados e funcionais, o processo de redefinição de senha faz o uso do método de envio definido no produto.

Parâmetros no DATASUL: Para mais informações sobre os parâmetros, acesse Parâmetros Email Foundation (BTB962ZB)

Parâmetros no DATASUL FOR THF: Para mais informações sobre os parâmetros, acesse E-mail.


Caso ocorra erro no processo de envio de e-mail, será retornada mensagem de erro.

A mensagem não possui detalhes, por não receber detalhes de erro da api de envio de e-mail.


03. Como enviar código de acesso para o usuário

Para realizar o envio do código de acesso, utilize o serviço passwordReset existente no contexto totvs-login, seguindo as premissas: 

  • O método de requisição é do tipo POST 
  • Não possui autenticação na requisição.
  • Deve ser enviado o parâmetro email, contendo o e-mail do usuário do produto, que está solicitando o código de acesso.
  • O usuário relacionado ao e-mail:
    • Deve ser do tipo INTERNO.
    • O e-mail não pode estar associado a mais de um usuário válido.
    • Não pode estar bloqueado;
    • Não pode estar inativo;
    • Caso não atenda os requisitos acima será retornado erro.
      • Erros sem mensagens
        • Erro de sintaxe inválida. ao utilizar o serviço terá como retorno status 400 Bad Request.
        • Exemplo: o parâmetro email errado(emaill) ou sem valor.
      • Erros com mensagens, são retornadas no formato JSON;

    • Documentação da manutenção de usuário: Manutenção de Usuário (SEC000AA)
  • Exemplo: 
    • http://<SERVIDOR>:<PORTA>/totvs-login/passwordReset?email=<E-MAIL_DO_USUÁRIO>


Ao executar o serviço com sucesso, o usuário receberá um e-mail contendo o código de acesso para redefinição de senha. O código de acesso deve ser encaminhado para o serviço de redefinição de senha, para mais informações leia o conteúdo 04. Como redefinir a senha.

Abaixo temos o exemplo de um e-mail padrão contendo o código de acesso:










  • Código de acesso:
    • É anulado após o seu uso na redefinição de senha;
    • É válido por 10 minutos, após este tempo será considerado como inválido;
  • O template de e-mail pode ser modificado.
    • Para mais informações leia o conteúdo: 05. Como modificar o template do e-mail.
  • O código de acesso pode ser enviado juntamente com uma URL.
    • Para mais informações leia o conteúdo: 06. Como adicionar URL com o código de acesso no e-mail.

04. Como redefinir a senha

Para redefinir a senha, utilize o serviço passwordReset existente no contexto totvs-login, seguindo as premissas: 

  • O método de requisição é do tipo POST 
  • Não possui autenticação na requisição.
  • A autorização para redefinição de senha será por meio do código de acesso.
  • Deve ser enviado um JSON no corpo da requisição com as informações:
    • guid: É o código de acesso, que o usuário recebeu por e-mail;
    • newPassword: É a nova senha do usuário;
    • confirmNewPassword: É a confirmação da senha do usuário;
    • Exemplo:
  • Caso não atenda os requisitos acima será retornado erro.
    • Erros sem mensagens
      • Erro de sintaxe inválida. ao utilizar o serviço terá como retorno status 400 Bad Request.
      • Exemplo: Corpo da requisição errada ou sem valor.
    • Erros com mensagens, são retornadas no formato JSON;
  • Exemplo:
    • http://<SERVIDOR>:<PORTA>/totvs-login/passwordReset


05. Como modificar o template do e-mail

A modificação do template do e-mail, ocorre por meio de uma chave referente a um template de e-mail parametrizado no produto, abaixo são apresentados os procedimentos: 

  • O parâmetro keyTemplate, dever ser enviado no serviço responsável pelo envio do código de acesso. 
  • Seguir os procedimentos apresentados no conteúdo: 03. Como enviar código de acesso para o usuário
  • Exemplo com o parâmetro keyTemplate: 
    • http://<SERVIDOR>:<PORTA>/totvs-login/passwordReset?email=<E-MAIL_DO_USUÁRIO>&keyTemplate=<CHAVE_DO_TEMPLATE>
  • Exemplo de e-mail recebido:

Abaixo são apresentados procedimentos para gerenciar Templates de e-mail utilizado no processo de redefinição de senha:

Como criar um Template de e-mail:

Como atualizar um Template de e-mail:

Como remover um Template de e-mail:




06. Como adicionar URL com o código de acesso no e-mail

dadsad


IMPORTANTE!

Disponível para releases 12.1.29 e superiores.