Usando as APIs

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á ao lado direito da tela a informação sobre a URL que deverá ser chamada a partir da aplicação. Veja Figura 1:

Figura 1 Exemplo de acesso a API de Risco

Observando o exemplo anterior, baseada no serviço de recuperações de informação de Risco, você pode clicar sobre o endpoint /external/mra/{ano}/ e será mostrado a ULR completa que a aplicação deverá acessar. Veja a próxima Figura:

Figura 2 Exemplo de URL utilizada para acessar o serviço

A URL que se apresenta na Figura 2 pode ser copiada e utilizada dentro da aplicação. Observando a parte final da URL, nota-se que existe a palavra “ano” entre chaves, o que sugere que alí deverá ser informado algum valor como parâmetro, por exemplo: 2019. 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 de dentro da aplicação acessa-la, aguardando e executando as devidas tratativas ao retorno que virá no formato JSON;

Para entender melhor o que é o formato JSON, veja os 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:

Figura 3 Exemplo de retorno da API pública

Como é possível observar na Figura 3, uma vez realizado o acesso a URL da API de forma direta, é retornado informações no formato JSON, cabendo ao desenvolvedor recuperar estas informações e utiliza-las de acordo com o propósito da aplicação em desenvolvimento.