Cross Segmentos - Backoffice RM - Integração - WebServices - Utilizando Webservices e API com TGM

 Tempo aproximado para leitura: 00:03:30 min

Dúvida
Como utilizar os WebServices e API do RM com o TGM?

Ambiente
Cross Segmentos - Backoffice RM - Integração - Todas as Versões.

Solução

O que é o TGM?
O TGM ( O TOTVS Gateway Manager) é um centralizador de requisições (ponto único de acesso), que realiza a análise, a filtragem e redirecionamento do tráfego de terceiros entre os hosts ativos.

As funções presentes no API Gateway permitem as mais diversas vantagens para quem o utiliza. Um único ponto de acesso, por exemplo, significa uma redução de esforço em administrar as "portas de entradas" dos serviços utilizados, podendo focar seus esforços em um único local.

As funções presentes no API Manager fornecem uma camada de gestão para o API Gateway. Além de definir o comportamento do API Gateway, o API Manager lida com a análise de cada requisição.

Para mais informações quanto a configuração do TGM:
Framework - Linha RM - Frame - TOTVS Gateway Manager (TGM)
A equipe responsável por esta configuração, é a equipe RM Framework, qualquer dúvida quanto a documentação ou configurações, poderá ser realizado o atendimento junto a esta equipe.


Como utilizar os WebServices e API do sistema com o TGM?
Quando o TGM esta instalado ao ambiente, configurado e totalmente funcional é possível validar as Portas configuradas a esta instalação:


Portas de configuração do TGM
Porta de serviço: Porta onde o TGM irá realizar o serviço de configuração.
Porta de resiliência: Porta onde o TGM irá realizar a resiliência do provider (NGINX).
Portas de escuta do TGM
Porta de WCF: Porta onde o TGM irá receber requisições TCP e redirecionar para os Hosts cadastrados para responder TCP.
Porta de WebService: Porta onde o TGM irá receber requisições HTTP e redirecionar para os Hosts cadastrados para responder HTTP.
Porta de WebApi: Porta para disponibilização do endpoint do serviço rest para configuração do TGM.
Connect (s): Valor em segundos para aguardar a conexão com o Proxy.
Time-out (s): Valor em segundos para aguardar a resposta da requisição.


Vejamos que em nosso ambiente possuímos 4 Serviços de Host instalados, cada qual estando funcional quando o funcionamento de seus WebServices e API, conforme a configuração abaixo:
Como Habilitar Webservice via RM Host


Ao realizar a validação se os serviços estão funcionais para o WebServices e para uso de API, todos estão sendo corretamente carregados, como exemplo a porta 8051 e 8053:
Porta 8051:
http://localhost:8051/wspageindex
http://localhost:8051/api/swagger/ui/index



Porta 8053:
http://localhost:8053/wspageindex
http://localhost:8053/api/swagger/ui/index



Como verificado, os serviços de WebServices e API do sistema em todos os serviços de Host instalados estão funcionais, mas para a utilização correta em um ambiente que possua o TGM instalado, este consumo de requisições deverá ser feito na Porta de escuta do TGM:


Ao qual desta forma irá garantir que o correto comportamento do TGM seja realizado, realizando o correto redirecionamento do tráfego entre os Hosts ativos do ambiente.

Desta forma a correta Porta para realizar as requisições WebServices e API do sistema é conforme a configuração realizada acima. No exemplo acima foi definido:
Porta  WCF 9050
Porta WebService 9051
Porta WebApi 9052

Ao teste podemos realizar a seguinte validação de consumo, ao utilizar a Porta de escuta do TGM, sendo esta a Porta WebServices 9051, o serviço do TBC é corretamente carregado:


Ao validar um WSDL qualquer deste TBC, podemos verificar que o serviço do TGM, esta utilizando a porta de escuta do TGM 9051 e nos direcionou para utilizar a Porta do Serviço 8055, que era uma porta disponivel neste momento:


Assim, quando é recarregada a pagina, apontando a mesma porta de escuta do TGM 9051, a porta a ser utilizada é diferente sendo agora no momento a Porta 8057:


Desta forma o TGM irá realizar todo redirecionamento  de portas necessárias para garantir o correto funcionamento do serviço.

Ao validar o consumo via API, o mesmo comportamento é também apresentado.
No exemplo configuramos a Porta de escuta do TGM Porta WebApi 9052:


Veja que o correto consumo da requisição API foi realizado com o apontamento para a Porta de Escuta Porta WebApi 9052 do TGM.



Saiba Mais:
Para mais informações quanto a configuração do TGM:
Framework - Linha RM - Frame - TOTVS Gateway Manager (TGM)

TOTVS Gateway Manager (TGM)