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 um detalhe de detalharemos cada um desses serviços.

GetKeySession – Retorna a chave para obter o contexto

O segundo primeiro serviço , chamado de GetKeySession, irá retornar a uma chave criptografada do contexto atual selecionado. Esse serviço do usuário no portal do aluno e deverá ser usada como parâmetro do segundo serviço (GetSession). O serviço GetKeySession utiliza o verbo de requisição GET e pode ser útil caso faça quando for necessário uma customização onde não seja que não possa ser feita através de um cadastro de Url Externa de Globais .

O cliente pode, por exemplo, obter a chave por meio deste serviço e posteriormente chamar o primeiro serviço para obter os dados do contexto atual.

e necessite das informações do contexto do usuário logado no portal.

...

Image Removed

Quando e como usar?

...

...

Exemplo de uma requisição do endpoint GetKeySession através do Swagger:

Image Added

Utilizando a documentação de customização, na tela de ocorrência do novo portal foi adicionado um botão que irá redirecionar para uma URL externa e passará via QueryString o KeySession, para isso no método de click do botão o serviço GetKeySession é chamado para recuperar a KeySession, essa key é repassada para uma URL externa:

Image Removed

Funcionamento do código de exemplo acima:

Image Removed

GetSession – Retorna o contexto atual do aluno

O primeiro segundo serviço , chamado de GetSession, irá retornar um objeto json 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 obtida pelo primeiro serviço GetKeySession.

...

...

...

...

...

...

...

Ao criar uma Url Externa, no cadastro de globais, essa chave é passada como parâmetro de Url (query string), como por exemplo:

http://meudominio.com.br/?key=<chave_criptografada>

 Image Removed

Como e quando usar?

...

...

...

 Image Added

No exemplo, foi criado um sistema Web em Asp.Net MVC em que existe uma Action que recebe a key, esta action chama o serviço GetSession e preenche na view de uma forma amigável os dados do contexto recuperado.

Funcionamento:

...

...

Quando e como usar?

Exemplo 1: Cliente precisa customizar a tela de ocorrência do portal adicionando um link para uma aplicação externa.

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.

Image Added

<button
        class="btn btn-default"
        ng-click="controller.abrirAppExterno()">
        Abrir aplicativo externo
</button>

Image Added

 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');
            });
        }

 self.abrirAppExterno = abrirAppExterno;

        function abrirAppExterno() {
            $.ajax({
                url: "http://localhost/FrameHTML/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:

Image Added

Exemplo 2: Cliente precisa adicionar uma URL externa ao menu do portal do aluno que redireciona para uma aplicativo externo passando o contexto.

Para isto, basta o Cliente realizar o cadastro da URL externa informando a URL do aplicativo externo que receberá o contexto. 

Image Added

Funcionamento:

Image Added

Image Added

Image Added

Aplicação de exemplo para acesso ao Contexto do portal do aluno (ASP.NET)

...

...