Histórico da Página

CONTEÚDO

1. Visão Geral
2. Como Identificar as API's
   
3. Exemplo de Identificação de utilizaçãoAPI
   
4. Tela XXX
   1. Outras Ações / Ações relacionadas
      
5. Tela XXX
   1. Principais Campos e Parâmetros
      
6. Tabelas utilizadas
7. Autenticação API
   
8. Exemplo de chamadas das API's

01. VISÃO GERAL

Todo desenvolvimento de telas em HTML junto ao Totvs TOTVS Saúde Planos - Linha Datasul é integrado com o backend através da API's. Essas API's seguem o padrão REST com troca de dados no formato JSON. Essas API's não estão documentadas, porém podem ser utilizadas pelos clientes para integração com sistemas e aplicativos externos.

Apesar de não estarem documentação documentadas, facilmente podem ser identificadas as API's, parâmetros e mensagem de envio e retorno através da utilização dos processos juntos ao TotvsTOTVS.

02. COMO IDENTIFICAR AS API's

Para identificar uma API a ser consumida por um serviço externo basta acessar a tela relacionada ao processo que se deseja integrar e abrir no browser as opções do desenvolvedor selecionando a opção Rede. Normalmente as opções do desenvolvedor são abertas ao pressionar o botão F12 do teclado.

Com essa aba aberta é possível navegar nas telas da aplicação e acompanhar todas as chamadas para as API's do TotvsTOTVS. Junto a aba de Redes é possível verificar o método da API (GET, POST, DELETE, ...), a URL da API, os parâmetros enviados através da URL, o JSON de envio, Status do retorno e também o JSON de retorno.

03.

...

EXEMPLO IDENTIFICAÇÃO DE API

O vídeo abaixo apresenta um exemplo de como identificar uma API de um processo do TotvsTOTVS. O exemplo em questão apresentar a identificação da consulta rápida dos contratantes através de um CPF. Veja que através da aba de Redes é possível verificar o método da API (GET), a URL, os parâmetros e também o JSON de retorno.

...

04.

...

Principais Campos e Parâmetros

...

AUTENTICAÇÃO API

Para que seja possível realizar uma chamada externa para uma API do TOTVS é necessário realizar a autenticação com um usuário válida. Para isso deve ser utilizado o processo de Basic Authentication informando o nome e senha do usuário.

05. EXEMPLO CHAMADA DA API

Para exemplificar como pode ser feita a chamada da API a partir de uma aplicação externa chamaremos a API de contratante apresentada no exemplo acima a partir da ferramenta Postman..

...