No artigo de hoje, vamos demonstrar em como consultar as documentações das APIs nativas da TOTVS disponíveis para usar.
Recentemente, alguns alunos perguntaram no nosso grupo do WhatsApp, sobre como pesquisar no api.totvs.com.br.
Então decidi montar esse artigo para exemplificar um pouco sobre, sendo que iremos demonstrar de 2 formas, uma sabendo o nome da API em REST e outra não sabendo.
Forma 1 – Sabendo o nome da API
- Acesse a URL que esta configurado o seu AppServer REST
- Encontre o nome da API (nesse caso vamos usar a SystemParameters)
Verificando a SystemParameters
- Você pode clicar no For more details ou abra o api.totvs.com.br
- Procure pelo nome da API e clique no pesquisar
Pesquisando por esse nome
- No resultado que irá aparecer, clique na documentação disponível
Encontrando a documentação
- Será aberto uma documentação completa da API com os métodos e com os resultados
Verificando os endpoints disponíveis
Forma 2 – Pesquisando sem saber o nome da API
- Acesse api.totvs.com.br e pesquise pelo termo desejado, nesse caso, vamos pesquisar por “saldo”
Pesquisando por palavra
- Após pesquisar, na esquerda, vamos filtrar apenas para o sistema que queremos, que no nosso exemplo, será o Protheus
Filtrando apenas para o ERP Protheus
- Com isso, ele mostrará o resultado, notem que trouxe 2 itens, e o que queremos usar aqui é esse Saldo em Estoque
Verificando as APIs
- Ao acessar a documentação, você pode navegar nela, e inclusive tem exemplos disponíveis para algumas linguagens
Verificando a requisição e visualizando o código em TL++
- Mas se precisar pesquisar na URL onde esta o seu REST, pegue o nome da API (nesse caso retailStockLevel)
Pegando o nome da API
- Ai basta acessar a URL onde esta o REST e pesquisar por esse nome
Pesquisando internamente no REST
Bom pessoal, por hoje é só.
Abraços e até a próxima.
