Versões comparadas
Chave
- Esta linha foi adicionada.
- Esta linha foi removida.
- A formatação mudou.
Conteúdo
Índice minLevel 2
01. Objetivo
Esta documentação tem a finalidade de servir como uma guia no momento da integração com o TOTVS Privacidade de Dados. Para mais informações sobre a ferramenta, acesse TOTVS Privacidade de Dados.
Para tanto, abaixo seguem as instruções para que a integração seja realizada corretamente.
02. Informações
Leia os documentos de referência do TOTVS Privacidade de Dados.
O produto Datasul faz o uso do Smart Link, que é um mecanismo de troca de mensagens entre aplicações TOTVSApps e aplicações OnPremises (ou remotas).
- Foi utilizada a biblioteca Smart Link Client Java, que por meio deste foi implementado o processador de mensagens.
- O processador de mensagens é uma aplicação java
Obtenha informações (client, secret, name e id)
do seu tenant para poder realizar as configurações necessárias nos passos.
03. Instalação
Copiar arquivo compactado
O arquivo está localizado no diretório do Foundation src/interfac/smart-link/dts-smart-link-client.zip
Extrair os arquivos do arquivo compactado
Extrair os arquivos em um deretório de sua escolha, sugerimos o uso do nome do seu tenant para complementar e facilitar a organização dos aterfatos.
Abaixo um exemplo:
- O nome da pasta extraida é dts-smart-link-client, e o complemento com o nome do tenant para exemplo é -totvs-fwk.
- Exemplo:
C:\TOTVS\dts-smart-link-client-totvs-fwk
- Exemplo:
- Como resultado temos a estrutura abaixo:
C:\TOTVS\dts-smart-link-client-totvs-fwk\README.txt
C:\TOTVS\dts-smart-link-client-totvs-fwk\lib\application.yml
C:\TOTVS\dts-smart-link-client-totvs-fwk\lib\dts-smart-link-client.jar
C:\TOTVS\dts-smart-link-client-totvs-fwk\service\Windows\install.bat
C:\TOTVS\dts-smart-link-client-totvs-fwk\service\Windows\JavaService.exe
C:\TOTVS\dts-smart-link-client-totvs-fwk\service\Windows\uninstall.bat
Instalador de serviço para Windows
Editar o arquivo "C:\TOTVS\dts-smart-link-client-totvs-fwk\service\Windows\install.bat"
Expandir | ||
---|---|---|
| ||
|
Expandir | ||
---|---|---|
| ||
|
Expandir | ||
---|---|---|
| ||
|
Expandir | ||
---|---|---|
| ||
|
Instalação do serviço:
- Execute Prompt de Comando como administrador
- Acesse o o arquivo
"C:\TOTVS\dts-smart-link-client-totvs-fwk\service\Windows\install.bat"
- Serviço instalado:
Desinstalador de serviço para Windows
Editar o arquivo "C:\TOTVS\dts-smart-link-client-totvs-fwk\service\Windows\uninstall.bat"
- Informe o nome do serviço definido na etapa anterior (Instalação)
- Image Added
Desinstalação do serviço:
- Execute Prompt de Comando como administrador
- Acesse o o arquivo
"C:\TOTVS\dts-smart-link-client-totvs-fwk\service\Windows\uninstall.bat"
- 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:
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 a mensagem do e-mail
A modificação da mensagem do e-mail ocorre por meio de um 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_REGISTRO>
Expandir | ||
---|---|---|
| ||
Expandir | ||
---|---|---|
| ||
Desenvolvendo o programa para modificar a mensagem do e-mail.
A mensagem deve ser criada em formato HTML;
A mensagem não pode utilizar a tag <script>;
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 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.
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 | |||||
---|---|---|---|---|---|
| |||||
|
http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/templates
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>/api/sec/v1/passwordReset/templates/fnd_access_code
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
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 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 a chave do registro na URL.
http://<SERVIDOR>:<PORTA>/api/sec/v1/passwordReset/templates/fnd_access_code
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