As evoluções da Linha RM utilizam a integração da MDI atual com APIs, tudo isso de forma transparente ao usuário.
Para o correto funcionamento dos novos recursos, é essencial realizar as configurações a seguir.

Essa documentação possui conteúdo totalmente técnico, direcione para o time de TI da empresa.

O primeiro passo é habilitar o uso das API's no ambiente, que são responsáveis por executar as ações e processos nas novas interfaces.


1. Configurando as portas API

O aplicativo RM.Host é responsável por hospedar e expor os serviços de APIs.
Para este passo precisamos focar na configuração da
tag ApiPort que será responsável por definir a porta pela qual as API's serão acessadas.

Veja com detalhes como realizar a configuração em configuração da porta webApi.

A execução do Host precisa ser como administrador:

  • Caso o Host seja iniciado como aplicativo (RM.Host.exe), certifique-se que ao executá-lo, tenha selecionado a opção "Executar como Administrador".
  • Caso o Host tenha sido instalado como serviço do windows, o usuário vinculado ao serviço deve ser um administrador do sistema.


Depois de realizada a configuração acima, é possível validar.

Acesse o browser e digite a URL  http://{IP ou domínio}:{porta}/api/swagger/.
Exemplo: http://10.173.17.242:8051/api/swagger

{IP ou domínio} - Na validação é extremamente importante usar o IP, nome da máquina ou domínio, principalmente em casos de ambiente 3 camadas ou smart client.

{porta} - A porta informada na URL é a mesma configurada na tag ApiPort


A configuração terá sido realizada com sucesso, caso uma página semelhante ao print abaixo seja apresentada.


       


2. Conectando com o banco de dados

O segundo passo é definir em qual banco de dados as APIs vão se conectar.
Para este passo precisamos focar na configuração da tag DefaulDB que será responsável por o banco de dados onde que a API vai consultar e salvar dados.

Veja com detalhes como realizar a configuração em Configurando DefaultDB.


Depois de realizada a configuração acima, é possível validar.

Acesse o browser e digite a URL  http://{IP ou domínio}:{porta}/api/framework/v1/companies
Exemplo: http://192.168.0.87:8055/api/framework/v1/companies

{IP ou domínio} - Na validação é extremamente importante usar o IP, nome da máquina ou domínio, principalmente em casos de ambiente 3 camadas ou smart client.

{porta} - A porta informada na URL é a mesma configurada na tag ApiPort


Neste exemplo estamos acessando o cadastro de coligadas, será solicitado um usuário (mesmo usado para acesso ao sistema) que tenha acesso a este cadastro.


A configuração terá sido realizada com sucesso, caso uma página semelhante ao print abaixo seja apresentada, com as informações das coligadas da base.