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
Índice minLevel 2
01. Objetivo
O serviço permite a redefinição de senha de um usuário do produto Datasul, por meio de API, deste modo permitindo que aplicativos consigam solicitar a redefinição de senha.
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
, p. Para mais informações sobre a propriedade, acesse Segurança.
Expandir | ||
---|---|---|
| ||
Mensagem no DATASUL Image Modified Mensagem no DATASUL FOR THF |
Image Added |
Verifique se os parâmetros de e-mail
estão configurados e funcionais, o . 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 | ||
---|---|---|
| ||
A mensagem não possui detalhes, por não receber detalhes de erro da Image Modified |
Verifique se os 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 e 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 | ||
---|---|---|
| ||
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 a configuração, acesse Gerais.
Expandir | ||
---|---|---|
| ||
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â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 . Para mais informações leia o conteúdo 04. Como redefinir a senha.
Informações |
---|
Código de acesso:
A mensagem do modificada.
|
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 doa 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
, dever 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>
Image Modified
Expandir | ||
---|---|---|
| ||
Expandir | ||
---|---|---|
| ||
Image Removed |
Gerenciamento de Templates
Image Added |
Desenvolvendo o programa para modificar a mensagem do e-mail.
A mensagem deve ser criada
Aviso |
---|
|
Regras para desenvolvimento do template
O template deve ser criado em formato HTML;
O template A mensagem não pode utilizar a tag <script>;O template não pode ultrapassar 1.000 caracteres;
Criar programa progress 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 | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
O parâmetro de entrada é do tipo JsonObject, será enviado com a estrutura e valores abaixo:
|
Expandir | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
Expandir | ||
---|---|---|
| ||
Image Removed |
title | Visualizar Tags |
---|
<password_reset_user_name>, será alterado para o nome do usuário relacionado ao e-mail.
Image Removed
<password_reset_url_guid>, será alterado para o valor da URL (06. Como adicionar URL com o código de acesso no e-mail).
Image Removed
Caso não existam valores para a substituição as tags serão removidas antes do envio de e-mail.
O parâmetro de saída é do tipo CHARACTER, onde deve ser retornada a mensagem HTML.
Programa de exemplo:
|
Como registrar um programa.
Como criar um Template
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 | ||
---|---|---|
| ||
|
Não pode passar o limite de 20 caracteres. Exemplos: fnd_access_code, app_rh_access_code.
|
Informar o programa responsável pela modificação da mensagem do e-mail.
|
|
|
http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/templates
Image Added
O método de requisição é do tipo PUT
A requisição precisa 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.
Expandir | |||||
---|---|---|---|---|---|
| |||||
|
Informar a chave do registro na URL.
http://<SERVIDOR>:<PORTA>
}http://SERVIDOR:PORTA
/api/sec/v1/passwordReset/templates
/fnd_access_code
Image Added
Como retornar um Template
Como retornar todos Templates
06. Como adicionar URL com o código de acesso no e-mail
dadsad
O método de requisição é do tipo DELETE
A requisição precisa 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 a chave do registro na URL.
http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/templates/fnd_access_code
Image Added
Como retornar um programa registrado.
O método de requisição é do tipo GET
A requisição precisa de autenticação. Para mais informações sobre autenticação de API acesse
URLs;
API
requer autenticação, para mais informações sobre autenticação de api acesse - Como retornar uma
URL
: - Como retornar todas as
URLs:
- Como criar uma
URL:
- Como atualizar uma
URL:
- Como remover um
URL:
icon | false |
---|
IMPORTANTE!
Disponível para releases 12.1.29 e superiores., deve se atentar com os modos de autenticação para DATASUL e DATASUL FOR THF.
Informar a chave do registro na URL.
http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/templates/fnd_access_code
Image Added
Como retornar todos os programas registrados.
O método de requisição é do tipo GET
A requisição precisa 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.
http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/templates
Image Added