Versões comparadas
Chave
- Esta linha foi adicionada.
- Esta linha foi removida.
- A formatação mudou.
Conteúdo
Objetivo Índice
Como enviar código de acesso para o usuário
Como redefinir a senha
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.
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 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 | ||
---|---|---|
| ||
A mensagem não possui detalhes, por não receber detalhes de erro da |
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.
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.
Informações |
---|
Código de acesso:
O template de A mensagem do
|
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: |
Expandir | ||
---|---|---|
| ||
Erros sem mensagens: Erro de sintaxe inválida, terá como retorno Erros com mensagens: são retornadas no formato |
http://<SERVIDOR>:<PORTA>/totvs-login/passwordReset
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>
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 |
---|
Neste momento, não existe uma interface gráfica para o gerenciamento de
A |
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;
title | Exemplo de HTML minificado |
---|
<!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 | |||||||
---|---|---|---|---|---|---|---|
| |||||||
|
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.
Como criar um Template
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:
O parâmetro de saída é do tipo CHARACTER, onde deve ser retornada a mensagem HTML.
Programa de exemplo:
|
Como registrar um programa.
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 | ||
---|---|---|
| ||
| ||
JSON |
Bloco de código | ||
---|---|---|
| ||
{ "key": "fnd_access_code", |
"value": " |
sec/exemplo.r" } |
http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/templates
Image RemovedImage Added
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 | ||
---|---|---|
| ||
| ||
JSON |
Bloco de código | ||
---|---|---|
| ||
{ "value": " |
}
sec/exemplo.r"
} |
Informar a chave do registro na URL.Atentar para a chave do template na URL
http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/templates/fnd_access_code
Image RemovedImage Added
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 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
Image Removed
Como retornar todos os Templates
programa registrado.
O método de requisição é do tipo GET
A requisição precisa ser autenticada.
http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/templates
Image Removed
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 | ||
---|---|---|
| ||
Image Removed |
title | Exemplo de e-mail padrão com o código de acesso na URL |
---|
Image Removed
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
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.
API
para gerenciamento de URLs requer autenticação. Para mais informações sobre autenticação de API acesse de 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.
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
, deve se atentar com os modos de autenticação para DATASUL e DATASUL FOR THF.
Informar a chave do registro na
{
"key": "fnd_access_code",
"value": "https://meu-endereco"
}
http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/urls
Image Removed
Como atualizar uma URL
O método de requisição é do tipo PUT
A requisição precisa ser autenticada.
title | Deve ser enviado um JSON no corpo da requisição |
---|
value
: Campo contendo a URL
{
"value": "https://meu-endereco"
}
Atentar para a chave da URL.
http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/urls/fnd_access_code
Image Removed
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/urlstemplates/fnd_access_code
Image RemovedImage Added
Como retornar uma URLtodos os programas registrados.
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
Image Removed
Como retornar todas as URLs
O método de requisição é do tipo GET
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.
http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/urls
Image Removed
06. 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.
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>
Image Removed
Image Removed
templates
Image Added
icon | false |
---|