Conteúdo

Objetivo

Índice

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

Como modificar template e adicionar URL com código de acesso no e-mail

minLevel	2

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

title	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.

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

title	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;

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â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>

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:

É 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.

Expandir

title	Deve ser enviado um JSON no corpo da requisição

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:

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.

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 deve 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

title	Caso não exista registro para chave, será utilizado o e-mail padrão

Expandir

title	Exemplo de e-mail modificado, recebido pelo usuário

Gerenciamento de Templates

Aviso

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;

Expandir

title	Exemplo de HTML minificado

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

Expandir

title	Exemplo de HTML sem minificação

Bloco de código

language	xml
theme	RDark

<!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>

Expandir

title	Resultado do e-mail recebido

São disponibilizadas tags para exibição de informação do nome do usuário e URL de acesso. Podemos verificar nos exemplos que estas tags são substituídas:

Expandir

title	Visualizar Tags

<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

title	Deve ser enviado um JSON no corpo da requisição

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

Expandir

title	Deve ser enviado um JSON no corpo da requisição

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

Atentar para a chave do template na URL

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

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

Para adicionar uma URL com código de acesso no e-mail, deve ser adicionado o parâmetro keyUrl com a chave da URL parametrizada no produto.

O parâmetro keyUrl 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>&keyUrl=<CHAVE_DA_URL>

Expandir

title	Caso não exista registro para chave, será enviado apenas o código

Expandir

title	Exemplo de e-mail padrão com o código de acesso na URL

Observar o Link https://meu-endereco?guid=d4c3fad5-ef7a-838b-6c14-31d8786eb05c

A URL parametrizada no produto keyUrl=fnd_access_code, possui o valor "https://meu-endereco", deste modo o valor sendo existente será enviado o código de acesso por meio do parâmetro guid "guid=d4c3fad5-ef7a-838b-6c14-31d8786eb05c"

Gerenciamento de URLs

Aviso

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.

Expandir

title	Deve ser enviado um JSON no corpo da requisição

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.

Expandir

title	Deve ser enviado um JSON no corpo da requisição

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

07. Como modificar template e adicionar URL com o código de acesso no e-mail

Para modificar template e adicionar URL com o código de acesso no e-mail, os parâmetros keyUrl e keyTemplate devem ser enviados no serviço responsável pelo envio do código de acesso.

O parâmetro keyTemplate foi apresentado no conteúdo 05. Como modificar o template do e-mail.

O parâmetro keyUrl foi apresentado no conteúdo 06. Como adicionar URL com o código de acesso no e-mail.

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

Informações

icon	false

IMPORTANTE!

Disponível para releases 12.1.29 e superiores.

Árvore de páginas

Versões comparadas

Versão antiga 164

Nova versão 165

Chave

Conteúdo

01. Objetivo

02. Configuração

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

04. Como redefinir a senha

05. Como modificar o template do e-mail

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

07. Como modificar template e adicionar URL com o código de acesso no e-mail

IMPORTANTE!

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 164

Nova versão 165

Chave

Conteúdo

01. Objetivo

02. Configuração

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

04. Como redefinir a senha

05. Como modificar o template do e-mail

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

07. Como modificar template e adicionar URL com o código de acesso no e-mail

IMPORTANTE!