Como utilizar uma API pública
Introdução
Não existe segredos na utilização de uma API pública. O fato de ser pública implica que as URLS estão propositalmente expostas sem nenhuma necessidade de autenticação por parte do usuário ou da aplicação.
Consumindo a API Pública
Ao acessar a documentação da API pública, você encontrará no lado direito da tela a informação sobre a URL que deverá ser chamada a partir da aplicação. Veja Figura 1:
Observando o exemplo anterior, baseado no serviço de recuperações de informação de Risco, você pode clicar sobre o link endpoint /external/mra/{ano}/ e será mostrado a URL completa que a aplicação deverá acessar. Veja a próxima Figura:
A URL que se apresenta na Figura 2 pode ser copiada e utilizada dentro da aplicação e, observando a parte final da URL, nota-se que existe a palavra “ano” entre chaves “{ }”, o que sugere que ali deverá ser informado algum valor como parâmetro, por exemplo: 2020. Assim a URL completa ficará da seguinte forma:
https://catalogo-risco-uat.api.apps.banestes.b.br/api/v1/external/mra/2020/
Uma vez que a URL esteja correta, é possível acessá-la de dentro da aplicação, aguardando e executando as devidas tratativas ao retorno que virá no formato JSON;
Para entender melhor o que é o formato JSON, veja a FAQ: Quais tecnologias preciso conhecer para utilizar as APIs do portal do desenvolvedor?
Uma forma de testar o retorno da API pública é utilizar a URL, devidamente parametrizada se for o caso, no próprio navegador ou em algum aplicativo que permita depurar requisições de APIs. Observe abaixo, na Figura 3, o link apresentado anteriormente sendo chamado diretamente do navegador:
Como é possível observar na Figura 3, uma vez realizado o acesso à URL da API de forma direta, é retornado informações no formato JSON, cabendo ao desenvolvedor recuperar essas informações e utilizá-las de acordo com o propósito da aplicação em desenvolvimento.