Conteúdo

Índice

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

Image RemovedImage Added

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

Verifique se os Parâmetros Gerais parâmetros gerais estão configurados e funcionais. O processo de redefinição de senha faz o uso das configurações na montagem da URL , para redefinição de senhae TOKEN no DATASUL.

DATASUL: Para mais informações sobre a configuração, acesse Janela Parâmetros Gerais Módulo Básico – Pasta Servidor, Parâmetros Gerais Módulo Básico (BTB946AA).

Expandir

title	Caso não exista configuração será gerado o erro.

Image Added

Verifique se a URL do RFI está configurada. O processo de redefinição de senha faz o uso da configuração na montagem da URL e TOKEN no DATASUL FOR THF.

DATASUL FOR THF: Para mais informações sobre informações sobre a configuração, acesse Configuração Servidor, Gerais.acesse Gerais.

Expandir

title	Caso não exista configuração será gerado o erro.

Image Added

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 A mensagem do e-mail pode ser modificadomodificada.

Para mais informações leia o conteúdo: 05. Como modificar o template a mensagem do 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

a mensagem do e-mail

A modificação do template do da mensagem do e-mail, ocorre 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 acessoum programa registrado, que será responsável pela criação da mensagem do e-mail. A chave do registro do programa deve ser enviada no parâmetro keyTemplate.

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

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

Image Removed

Gerenciamento de Templates

Aviso

Os Templates são utilizados especificamente pelo serviço 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, deve se atentar com os modos de autenticação para Antiga Arquitetura (JBOSS) e Nova arquitetura DTS4THF(TOMCAT).
Não será realizada validação do programa ao cadastrar ou atualizar o registro na API de gerenciamento de templates.
Caso aconteça algum erro em tempo de execução com o programa informado no registro na API de gerenciamento de templates, será lançado erro no arquivo de log do servidor de aplicação progress e será retornado template padrão.

Image Added

Desenvolvendo o programa para modificar a mensagem do e-mail.

A mensagem deve ser criada

Regras para desenvolvimento do template

O template deve ser criado em formato HTML;

O template A mensagem não pode utilizar a tag <script>;

Deve ser criado um Criar programa progress para retornar o Template HTML para retornar a mensagem do e-mail, neste programa deve existir a procedure pi-html, tendo como parâmetro de entrada JsonObject e parâmetro de saída CHARACTER.

Expandir

title	Programa de exemplo

O parâmetro de entrada é do tipo JsonObject possuindo , será enviado com a estrutura e valores abaixo:

Bloco de código

theme	RDark

{
  "guid": "Código de acesso do usuário",
  "cod_usuario": "Código do usuário",
  "nom_usuario": "Nome do usuário"
  "url": "Servidor e porta configurados em Parâmetros Gerais, Para mais informações leia o conteúdo 02. Configuração",
}

O parâmetro de saída é do tipo CHARACTER, onde deve ser retornado o Template retornada a mensagem HTML.

Bloco de código

theme	RDark
title	Assinatura da Procedure

USING Progress.Json.ObjectModel.*.

{include/i-prgvrs.i EXEMPLO 2.00.00.001 }

PROCEDURE pi-html:
    DEFINE INPUT   PARAMETER jsonIn    AS JsonObject NO-UNDO.
    DEFINE OUTPUT  PARAMETER htmlOut   AS CHARACTER  NO-UNDO.
	
	//Implementar Lógica para criar o retorno HTML    
END PROCEDURE.

Exemplo de programa retornando Template HtmlPrograma de exemplo:

View file

name	exemplo.zip
height	250

Expandir

title	Resultado do e-mail

Image RemovedImage Added

Como criar registrar um Templateprograma.

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

A requisição precisa ser autenticadade autenticação. Para mais informações sobre autenticação de API acesse a página Desenvolvimento de APIs para o produto Datasul, deve se atentar com os modos de autenticação para DATASUL e DATASUL FOR THF.

Não será realizada validação do programa ao registrá-lo.

Caso aconteça algum erro em tempo de execução com o programa registrado, será lançado erro no arquivo de log do servidor de aplicação Progress e será retornada mensagem padrão.

Expandir

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

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

value: Campo contendo Informar o programa reponsável pelo retorno do Template HTMLresponsável pela modificação da mensagem do e-mail.

Bloco de código

theme	RDark

{
  "key": "fnd_access_code",
  "value": "sec/exemplo.pr"
}

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

Image RemovedImage Added

Como atualizar um Templateo registro de um programa.

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

A requisição precisa ser autenticadade autenticação. Para mais informações sobre autenticação de API acesse a página Desenvolvimento de APIs para o produto Datasul, deve se atentar com os modos de autenticação para DATASUL e DATASUL FOR THF.

Expandir

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

value: Campo contendo Informar o programa reponsável pelo retorno do Template HTMLresponsável pela modificação da mensagem do e-mail.

Bloco de código

theme	RDark

{
  "value": "sec/exemplo.pr"
}

Atentar para Informar a chave do template registro na URL.

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

Image RemovedImage Added

Como remover um Templateprograma registrado.

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

A requisição precisa ser autenticada.de autenticação. Para mais informações sobre autenticação de API acesse a página Desenvolvimento de APIs para o produto Datasul, deve se atentar com os modos de autenticação para Antiga Arquitetura (JBOSS) e Nova arquitetura DTS4THF(TOMCAT).

Informar Atentar para a chave do template registro na URL.

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

Como retornar um Templateprograma registrado.

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

A requisição precisa ser autenticada.de autenticação. Para mais informações sobre autenticação de API acesse a página Desenvolvimento de APIs para o produto Datasul, deve se atentar com os modos de autenticação para DATASUL e DATASUL FOR THF.

Informar Atentar para a chave do template registro na URL.

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

Image RemovedImage Added

Árvore de páginas

Versões comparadas

Versão antiga 186

Nova versão Atual

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

a mensagem do e-mail

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 186

Nova versão Atual

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

a mensagem do e-mail