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.


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. 

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.



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.

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;

  • Erros sem mensagens: Erro de sintaxe inválida, 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)

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.

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.

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:

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;

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.   



http://<SERVIDOR>:<PORTA>/totvs-login/passwordReset?email=<E-MAIL_DO_USUÁRIO>&keyTemplate=<CHAVE_DO_TEMPLATE> 




Gerenciamento de Templates


Neste momento, não existe uma interface gráfica para o gerenciamento de Templates;

  • Os Templates são utilizados especificamente para o processo de redefinição de senha.

A API para gerenciamento de templates requer autenticação, para mais informações sobre autenticação de API acesse a página Desenvolvimento de APIs para o produto Datasul



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;


<!doctype html><html><head><meta charset='utf-8'></head><body><h2>Caro, <password_reset_user_name></h2><p>Voc&ecirc; fez a solicita&ccedil;&atilde;o de redefini&ccedil;&atilde;o de senha.</p><p>O c&oacute;digo de acesso para redefini&ccedil;&atilde;o de senha &eacute;:<password_reset_url_guid></p><p>A nova senha deve atender aos crit&eacute;rios conforme a politica de seguran&ccedil;a.</p><p>Em caso de usu&aacute;rio bloqueado, entre em contato com suporte - 00 0000-0000 op&ccedil;&atilde;o 0</p><p><br /><strong>Atenciosamente,</strong></p><p><strong>Seguran&ccedil;a da informa&ccedil;&atilde;o Corporativa</strong></p><p>&nbsp;</p></body></html>

<!doctype html>
<html>

<head>
	<meta charset='utf-8'>
</head>

<body>
	<h2>Caro, <password_reset_user_name></h2>
	<p>Você fez a solicitação de redefinição de senha.</p>
	<p>O código de acesso para redefinição de senha é: <password_reset_url_guid></p>
	<p>A nova senha deve atender aos critérios conforme a politica de segurança.</p>
	<p>Em caso de usuário bloqueado, entre em contato com suporte - 00 0000-0000 opção 0</p>
	
	<p><br /><strong>Atenciosamente,</strong></p>
	<p><strong>Segurança da informação Corporativa</strong></p>
	<p> </p>
</body>

</html>

São disponibilizadas tags para exibição de informação do nome do usuário e URL de acesso, podemos verificar que no exemplo de HTML existem tags inválidas para o HTML que serão substituídas:

<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

key: Chave do template, não pode passar o limite de 20 caracteres. Exemplos: fnd_access_code, app_rh_access_code

value: Campo contendo o Template HTML

JSON

{
  "key": "fnd_access_code",
  "value": "<!doctype html><html><head><meta charset='utf-8'></head><body><h2>Caro, <password_reset_user_name></h2><p>Voc&ecirc; fez a solicita&ccedil;&atilde;o de redefini&ccedil;&atilde;o de senha.</p><p>O c&oacute;digo de acesso para redefini&ccedil;&atilde;o de senha &eacute;:<password_reset_url_guid></p><p>A nova senha deve atender aos crit&eacute;rios conforme a politica de seguran&ccedil;a.</p><p>Em caso de usu&aacute;rio bloqueado, entre em contato com suporte - 00 0000-0000 op&ccedil;&atilde;o 0</p><p><br /><strong>Atenciosamente,</strong></p><p><strong>Seguran&ccedil;a da informa&ccedil;&atilde;o Corporativa</strong></p><p>&nbsp;</p></body></html>"
}

http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/templates



Como atualizar um Template

O método de requisição é do tipo PUT

A requisição precisa ser autenticada

value: Campo contendo o Template HTML

JSON

{
  "value": "<!doctype html><html><head><meta charset='utf-8'></head><body><h2>Caro, <password_reset_user_name></h2><p>Voc&ecirc; fez a solicita&ccedil;&atilde;o de redefini&ccedil;&atilde;o de senha.</p><p>O c&oacute;digo de acesso para redefini&ccedil;&atilde;o de senha &eacute;:<password_reset_url_guid></p><p>A nova senha deve atender aos crit&eacute;rios conforme a politica de seguran&ccedil;a.</p><p>Em caso de usu&aacute;rio bloqueado, entre em contato com suporte - 00 0000-0000 op&ccedil;&atilde;o 0</p><p><br /><strong>Atenciosamente,</strong></p><p><strong>Seguran&ccedil;a da informa&ccedil;&atilde;o Corporativa</strong></p><p>&nbsp;</p></body></html>"
}

Atentar para a chave do template na URL

http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/templates/fnd_access_code



Como remover um Template

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


Gerenciamento de URLs

Neste momento, não existe uma interface gráfica para o gerenciamento de URLs;

  • As URLs são utilizadas especificamente para o processo de redefinição de senha.

A API para gerenciamento de URLs requer autenticação, para mais informações sobre autenticação de API acesse a página Desenvolvimento de APIs para o produto Datasul



Como criar uma URL

O método de requisição é do tipo POST 

A requisição precisa ser autenticada

key: Chave da URL, não pode passar o limite de 20 caracteres. Exemplos: fnd_access_code, app_rh_access_code

value: Campo contendo a URL

JSON

{
  "key": "fnd_access_code",
  "value": "https://meu-endereco"
}

http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/urls



Como atualizar uma URL

O método de requisição é do tipo PUT

A requisição precisa ser autenticada

value: Campo contendo a URL

JSON

{
  "value": "https://meu-endereco"
}

Atentar para a chave da URL

http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/urls/fnd_access_code



Como remover uma URL

O método de requisição é do tipo DELETE

A requisição precisa ser autenticada

Atentar para a chave da URL

http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/urls/fnd_access_code



Como retornar uma URL

O método de requisição é do tipo GET

A requisição precisa ser autenticada

Atentar para a chave da URL

http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/urls/fnd_access_code



Como retornar todas URLs

O método de requisição é do tipo GET

A requisição precisa ser autenticada

http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/urls



IMPORTANTE!

Disponível para releases 12.1.29 e superiores.