Pré-requisitos/Parametrizações

Não se aplica.

Descrição do processo

Tela de parâmetros para que o usuário defina o Token necessário para validar o acesso à Web Services disponibilizados pela TOTVS e também definir qual o número da Coligada SESI e SENAI no Departamento Regional.

Detalhamento do processo

No TOTVS Educacional, por meio da opção “Parâmetros Gerais”, disponível no menu "Customização", o usuário administrador efetua as parametrizações necessárias para as customizações do Departamento Nacional.

Devem ser parametrizadas as seguintes informações:

• • Token Basic Auth

    Token necessário para validar acesso aos Web Services da TOTVS nas customizações disponibilizadas pelo Departamento Nacional. Este Token é a informação de algum Usuário do SGE e sua senha criptografados de acordo com o modelo de autenticação disponível.

    O código criptografado deve ser enviado toda vez que for acionado algum Web Service disponibilizado pela TOTVS para as Customizações do Departamento Nacional. A customização será capaz de descriptografar o código enviado para então realizar uma tentativa de login no SGE com o Usuário e Senha utilizados para a criptografia.

    Para gerar o Token é necessário executar o processo "Gerar Token" acessível pela opção "Processos" da tela de Parâmetros.

    
    

    Deck of Cards
    id GerarToken
    Card deck 1passo id 1passo label 1° passo title 1° passo card 1° passo Na primeira tela do processo o usuário visualiza as opções de autenticação disponíveis (até o momento é somente BasicAuth). Card deck 2passo id 2passo label 2° passo title 2° passo card 2° passo Na segunda etapa o usuário deve definir qual usuário e senha serão criptografados mediante o modelo de autenticação. Card deck 3passo id 3passo label 3° passo title 3° passo card 3° passo Em seguida o usuário deve clicar em Executar. Card deck 4 id 4passo label 4° passo title 4° passo card 4° passo Por fim, é apresentado o log de execução do processo.

    O Token gerado pode ser visualizado no parâmetro "Token Basic Auth".
    

• • Coligada SENAI
    Usuário deve determinar entre as Coligadas existentes na base de dados qual dela corresponde à Coligada SENAI.
    

• • Coligada SESI
    Usuário deve determinar entre as Coligadas existentes na base de dados qual dela corresponde à Coligada SENAI.
    

Pré-requisitos/Parametrizações

Não se aplica.

Descrição do processo

Tela de parâmetros para que o usuário defina qual customização ele quer utilizar ou não em seu ambiente.

Detalhamento do processo

No TOTVS Serviços Globais, por meio da opção “Controle de Customizações Ativas”, disponível no menu "Customização", o usuário administrador efetua a ativação ou desativação para as customizações do Departamento Nacional que deseja utilizar em seu ambiente.

Para ativar ou desativar uma customização deverá ser realizados os seguintes passos:

• • Selecione o projeto que deseja realizar a ação pelo nome, clique em Editar marque ou desmarque a opção Ativada

    
    

    
    

    Nota
    Apos ativar/desativar uma customização deve-se reiniciar o RM.Host das maquinas do servidor

    
    
    

Pré-Requisitos / ParametrizaçõesTeste

Âncora
WebServiceConsulta WebServiceConsulta

Detalhamento do Processo

Foi desenvolvido um Web Service destinado a executar consultas SQL's cadastradas no RM.

Ao realizar a instalação da customização, ele estará disponível para acesso através do serviço do RM.

Swagger

Todos os serviços disponíveis no RM são agrupados e listados nessa ferramenta, que visa auxiliar na manutenção e documentação de APIs REST.

Para acessar o Swagger, é necessário acessar o link no seguinte formato "http://<servidor>:<portaFrameHTML>/swagger/ui/index" (Exemplo: http://localhost:8080/swagger/ui/index).

Para verificar a porta, acesse, através do IIS, o Website "FrameHTML", que é gerado quando realizada a instalação do Portal RM:

Após isso, basta clicar com o botão direito do mouse no Website "FrameHTML" e clicar na opção "Editar ligações...". Conforme imagem abaixo, a porta seria a 8080, e o link ficaria da seguinte forma "http://localhost:8080/swagger/ui/index".

Ao acessar o Swagger, serão listados todos os serviços disponíveis, com a descrição do serviço, parâmetros e urls:

O webservice de consultas SQL é o "CstExecSQL", método "ExecutaConsultaSQL".

Segurança

Para a autenticação no Web Service, é utilizado um Token, gerado pela tela de parametrização da customização.

Para isso, o usuário deverá acessar a tela de Parâmetros, no menu "TOTVS Educacional→Customização→Parâmetros". 

Após acessar a tela, preencher os campos Usuário e Senha com dados válidos para realizar um login no RM. Em seguida, executar o processo "Gerar Token".

O Token gerado no campo "Token Portal Transparência V2" deverá ser enviado em todas as requisições, no header "Authorization", da seguinte forma: Basic token_gerado.

Para maiores detalhes, acesse aqui o manual da Lib DN.

Parâmetros do Web Service

O web service possui 3 parâmetros, sendo dois deles obrigatórios e todos enviados via GET:

Exemplo de uma requisição enviada para o WebService

Consulta SQL cadastrada no RM, com o código "CstTesteFiltros".

Como podemos ver na imagem abaixo, ela retorna os dados do município e tem um parâmetro (MUNICIPIO).

Exemplo do envio da requisição via Postman:

Código da requisição em HTTP

GET /rm/api/TOTVSCustomizacao/ConsultasSQL/ExecutaConsultaSQL?codColigada=0&amp;codSentenca=CstTesteFiltros&amp;parameters=MUNICIPIO=Belo Horizonte HTTP/1.1
Host: localhost:8080
Authorization: Basic bWVzdHJlOnRvdHZz

Lista Códigos dos Sistemas