API TOTVS RM

As APIS são conjuntos de regras e protocolos que permitem com que aplicações comunica entre si. Aplicações são sistemas que podem ser desenvolvidas em tecnologias diferentes e com uso da API você pode integrar eles.

Ao utilizar o TOTVS RM você pode se deparar com dois tipos de autenticação padrão que são XML e API REST. Os web services SOAP,  que são as - integrações por XML - podem ser acessadas por este link. As integrações por REST API podem ser acessados por aqui.

Porém nem todos sabem que é uma forma alternativa de se consultar as documentações das INTEGRAÇÕES do TOTVS RM que é utilizando o utiliário TOTVS RM WEBSERVICE.

Para este caso é necessário que você possua uma instalação do TOTVS RM.

Utilitário TOTVS RM WebService.

Uma forma interessante de se consultar a documentação dos web services é através do utilitário do web services do TOTVS RM.

Este utilitário está disponível na pasta de instalação do TOTVS,  através do caminho c:/totvs/rm.net , localize e dê duplo clique no arquivo TotvsWSClient.exe

Ao acessar o software você vai se deparar com um menu a esquerda onde estão as configurações de seu ambiente. Será necessário informar o localhost e a porta do seu web Service do TOTVS RM, também será necessário informar o usuário e senha.

Próximo passo é utilizar o campo de busca de DATASERVER você vai querer observar a sua estrutura. De forma bem simplista um DATASERVER é uma representação da tela do sistema. Por exemplo dentro do sistema você tem a tela de lançamentos financeiros, logo aquela tela representa um DATASERVER.

Observação: algumas telas do sistema levam o nome TBC no final, como é o caso da tela de Movimentos do sistema.

No exemplo abaixo eu estou filtrando o dataserver FinLanDataBR. Ao selecionar este data serve você pode clicar no botão carregar.

Se os campos estiverem devidamente configurados então o sistema irá listar as colunas da tela. Você pode assimilar a tela como um conjunto de tabelas do sistema que estão relacionadas entre si, e os campos são as colunas das tabelas do banco de dados. Uma curiosidade é que nestes casos onde a Campos com o mesmo nome você poderá ter dificuldades na representação da informação ou aplicar filtro, nestes casos é necessário informar o [NOMEDATABELA.NOMEDACOLUNA] igual se faz no banco de dados.

Coluna HELP

A coluna de ajudar a mostrar pelo data servir qual é a chave primária necessária para realizar a consulta quando for realizar o ReadRecord, também mostra a lista de Campos das tabelas envolvidas na tela.