Versões comparadas
Chave
- Esta linha foi adicionada.
- Esta linha foi removida.
- A formatação mudou.
Conteúdo
Í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.
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
|
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 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 | ||
---|---|---|
| ||
|
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, acesse Gerais.
Expandir | ||
---|---|---|
| ||
|
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 programa responsável por retornar o 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 | ||
---|---|---|
| ||
Expandir | ||
---|---|---|
| ||
|
Desenvolvendo o programa para criar template de modificar a mensagem do e-mail.
O template A mensagem deve ser criado criada 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 | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||
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 retornado o Template retornada a mensagem HTML.
Exemplo de programa retornando Template HtmlPrograma de exemplo:
|
Como registrar um programa.
O método de requisição é do tipo POST
A requisição precisa de autenticação
Gerenciamento dos registros de programas
Templates
são utilizados especificamente pelo serviço de redefinição de senha.API
requer autenticação. Para mais informações sobre autenticação
de API acessede 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)para DATASUL e DATASUL FOR THF.
Não será realizada validação do programa ao
cadastrar ou atualizar o registro naAPI
de gerenciamento de templates.
registrá-lo.
Caso aconteça algum erro em tempo de execução com o programa
informado no registro naAPI
de gerenciamento de templates
registrado, será lançado erro no arquivo de log do servidor de aplicação
progressProgress e será
retornado templateretornada mensagem padrão.
Como criar um Template
O método de requisição é do tipo POST
A requisição precisa ser autenticada.
Expandir | |||||
---|---|---|---|---|---|
| |||||
|
http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/templates
Image Removed
Image 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 | |||||
---|---|---|---|---|---|
| |||||
|
Atentar para Informar a chave do template registro na URL.
http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/templates/fnd_access_code
Image Removed
Image 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 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 Removed
Image Added
Como retornar todos os Templatesos programas registrados.
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/templates
Image Removed
Image Added