Foram desenvolvidos dois serviços REST para que o cliente possa customizar sua aplicação de acordo com o contexto educacional atual do portal do aluno. Abaixo detalharemos cada um desses serviços.
O primeiro serviço, chamado de GetKeySession, irá retornar a chave criptografada do contexto atual selecionado. Esse serviço utiliza o verbo de requisição GET e pode ser útil quando for necessário uma customização que não possa ser feita através de um cadastro de Url Externa de Globais.
Neste caso, o cliente deve obter a chave, por meio deste serviço, e posteriormente chamar o segundo serviço para obter os dados do contexto atual.
O endereço para acessar o serviço é o seguinte:
http://<nome_do_servidor_ou_ip>/rm/api/TOTVSEducacional/GetKeySession
O serviço GetKeySession necessita da sessão em que o usuário está logado, por isso, só funcionará se for executado dentro do ambiente do portal. |
O segundo serviço, chamado de GetSession, irá retornar um objeto json com os dados de contexto do aluno. Esse serviço utiliza o verbo de requisição GET e recebe como parâmetro uma chave criptografada de nome key.
O endereço para acessar o serviço é o seguinte:
http://<nome_do_servidor_ou_ip>/rm/api/TOTVSEducacional/GetSession?key=<chave_criptografada>
É obrigatório passar uma chave criptografada para que este serviço retorne os dados. Essa chave é obtida por meio do serviço GetKeySession. É obrigatório configurar a TAG ServiceAlias no arquivo Web.config da pasta FrameHTML para que este serviço funcione corretamente. O serviço GetSession deve ser executado de fora do ambiente do portal. |
Modelo do JSON que é retornado pelo GetSession (lembrando que um dado pode ou não estar preenchido baseado no usuário logado): { ], |
Para isso, utilizando a documentação de customização, podemos alterar esta tela e adicionar um botão que irá redirecionar para a URL de uma aplicação externa. No código abaixo, no evento do click deste botão, o serviço GetKeySession é chamado para recuperar a KeySession e, posteriormente, essa key será repassada para o aplicativo externo via QueryString.
<button class="btn btn-default" ng-click="controller.abrirAppExterno()"> Abrir aplicativo externo </button> |
self.abrirAppExterno = abrirAppExterno; function abrirAppExterno() { $.ajax({ url: "http://localhost:8025/rm/api/TOTVSEducacional/GetKeySession", crossDomain: true, context: document.body, type: "get", xhrFields: {withCredentials: true} }).done(function(data){ var url = "http://localhost/testeintegracao/TesteURLExterna?key=" + data; window.open(url, '_blank'); }); } |
Funcionamento do código de exemplo acima:
Para isto, basta o Cliente realizar o cadastro da URL externa informando a URL do aplicativo externo que receberá o contexto.
Funcionamento:
Segue abaixo o código fonte da aplicação web Asp. Net utilizada nos exemplos acima.
Para reproduzir os exemplos basta extrair os fontes em um diretório e criar um aplicativo web. Isto pode ser feito no Gerenciador de Serviços de Informações da Internet (IIS), por exemplo. No próprio aplicativo já estão descritas as instruções de uso. |