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
A recuperação de senha deve estar ativa no produto.
DATASUL: É habilitada por meio da propriedade enable.recover.password, para mais informações sobre a propriedade, acesse Documentação "datasul_framework.properties".
DATASUL FOR THF: É habilitada nas Propriedades do Sistema, para mais informações sobre a propriedade, acesse Segurança.
Expandir | ||
---|---|---|
| ||
Mensagem no DATASUL Image Modified Mensagem no DATASUL FOR THF Image Modified |
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.
DATASUL: Para mais informações sobre os parâmetros, acesse Parâmetros Email Foundation (BTB962ZB)
DATASUL FOR THF: Para mais informações sobre os parâmetros, acesse E-mail.
Expandir | ||
---|---|---|
| ||
A mensagem não possui detalhes, por não receber detalhes de erro da Image Modified |
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â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;
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
;:Image Modified
Documentação da manutenção de usuário: Manutenção de Usuário (SEC000AA)
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.
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 |
---|
Código de acesso:
O template de
O código de acesso pode ser enviado juntamente com uma URL.
|
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 | ||
---|---|---|
| ||
Exemplo: Image Modified |
Expandir | ||
---|---|---|
| ||
Erros sem mensagens: Erro de sintaxe inválida, terá como retorno Erros com mensagens, são retornadas no formato Image Modified |
http://<SERVIDOR>:<PORTA>/totvs-login/passwordReset
Image Modified
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.
http://<SERVIDOR>:<PORTA>/totvs-login/passwordReset?email=<E-MAIL_DO_USUÁRIO>&keyTemplate=<CHAVE_DO_TEMPLATE>
Expandir | ||
---|---|---|
| ||
Expandir | ||
---|---|---|
| ||
Gerenciamento de Templates
Aviso |
---|
|
Regras para desenvolvimento do template
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;
Expandir | ||
---|---|---|
| ||
|
Expandir | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
Expandir | ||
---|---|---|
| ||
Expandir | ||
---|---|---|
| ||
<password_reset_user_name>, será alterado para o nome do usuário relacionado ao e-mail. <password_reset_url_guid>, será alterado para o valor da URL (06. Como adicionar URL com o código de acesso no e-mail). Caso não existam valores para a substituição as tags serão removidas antes do envio de e-mail. |
Como criar um Template
O método de requisição é do tipo POST
A requisição precisa ser autenticada
Expandir | ||
---|---|---|
| ||
|
http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/templates
O método de requisição é do tipo PUT
A requisição precisa ser autenticada
Expandir | ||
---|---|---|
| ||
|
Atentar para a chave do template na URL
http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/templates/fnd_access_code
O método de requisição é do tipo DELETE
A requisição precisa ser autenticada
Atentar para a chave do template na URL
http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/templates/fnd_access_code
Como retornar um Template
O método de requisição é do tipo GET
A requisição precisa ser autenticada
Atentar para a chave do template na URL
http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/templates/fnd_access_code
Como retornar todos Templates
O método de requisição é do tipo GET
A requisição precisa ser autenticada
http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/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. |