Versões comparadas
Chave
- Esta linha foi adicionada.
- Esta linha foi removida.
- A formatação mudou.
Conteúdo
Visão Geral
- Configuração
Como enviar código de acesso para o usuário
Como redefinir a senha
- Como modificar template do e-mail
- Como adicionar URL com código de acesso no e-mail
01. Visão geral
.......
....
.....
,,,,
02. Configuração
Informações |
---|
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.
Aviso |
---|
Caso a recuperação de senha não esteja ativa, será retornada mensagem de ERRO. |
Mensagem no DATASUL
Mensagem no DATASUL FOR THF
Informações |
---|
Verifique se os parâmetros de |
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.
Aviso |
---|
Caso ocorra erro no processo de envio de A mensagem não possui detalhes, por não receber detalhes de erro da |
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.
D
eve ser enviado o parâmetroemail
, 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;
Expandir title Caso não atenda os requisitos acima será retornado erro Erros sem mensagens: Erro de sintaxe inválida, terá como retorno
status 400 Bad Request.
Exemplo: o parâmetroemail
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)
- Deve ser do tipo
Expandir title Exemplo http://<SERVIDOR>:<PORTA>/totvs-login/passwordReset?email=<E-MAIL_DO_USUÁRIO>
Image Modified
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.
Expandir | ||
---|---|---|
| ||
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.
Informações |
---|
|
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.
Expandir title 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 pore-mail
;newPassword
: É a nova senha do usuário;confirmNewPassword
: É a confirmação da senha do usuário;Exemplo:
Expandir title Caso não atenda os requisitos acima será retornado erro Erros sem mensagens: Erro de sintaxe inválida, 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
;Expandir title 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 ao template de e-mail parametrizado no produto. Deste modo o parâmetro keyTemplate
, dever ser enviado no serviço responsável pelo envio do código de acesso.
Expandir | ||
---|---|---|
| ||
URL: http://<SERVIDOR>:<PORTA>/totvs-login/passwordReset?email=<E-MAIL_DO_USUÁRIO>&keyTemplate=<CHAVE_DO_TEMPLATE> Caso não exista registro para chave, será utilizado o Exemplo de |
Gerenciamento de Templates
Aviso |
---|
|
Regras para desenvolvimento do template
Expandir | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||
O template deve ser criado em formato HTML; O template não pode utilizar a tag <script>; O template não pode ultrapassar 1.000 caracteres;
São disponibilizadas chaves para exibição de informação no e-mail, podemos verificar que no exemplo de HTML existem os valores:
|
Como criar um Template
Como retornar um Template
Como retornar todos Templates
06. Como adicionar URL com o código de acesso no e-mail
dadsad
Aviso |
---|
|
- Como retornar uma
URL
: - Como retornar todas as
URLs:
- Como criar uma
URL:
- Como atualizar uma
URL:
- Como remover um
URL:
Informações | ||
---|---|---|
| ||
IMPORTANTE!Disponível para releases 12.1.29 e superiores. |