.
    VOCÊ ESTÁ AQUI:
  1. Início

API de dados

Sobre a API

O Portal da Transparência está atento aos princípios de Governo Eletrônico e sabe que os dados devem ser disponibilizados de formas diferentes a fim de atender aos diversos perfis de usuários. Para isso, além de consultas online e com visualizações que buscam transmitir, de forma simples, como o governo usa os recursos públicos, formas de acesso aos dados para desenvolvedores e engajados com a tecnologia da informação também estão disponíveis.

O acesso para desenvolvedores e engajados ocorre através de uma Interface de Programa de Aplicativos (do inglês, “Application Programming Interface”), ou simplesmente “API”. Com ela, é possível ter um serviço de consulta direta aos dados do Portal da Transparência sem precisar navegar pelo site ou utilizar robôs para a obtenção das informações de forma automática. Os dados disponíveis são os mesmos apresentados em tela, com a flexibilidade característica das APIs.

No Portal da Transparência, o serviço de consulta via API foi implementado em REST (Representational State Transfer). Entendemos que o REST é mais simples de ser utilizado, além de poder ser testado aqui mesmo no Portal. Além do mais, o REST costuma ser a escolha preferida dos desenvolvedores.

O acesso via API fornece toda uma flexibilidade para consultas pontuais. Para acesso ao conjunto completo de dados, no entanto, sugerimos utilizar as planilhas de dados abertos. O Portal da Transparência agrega uma enorme quantidade de dados e baixar as planilhas para uso local certamente fornecerá melhores resultados para grandes volumes de dados.

Mas afinal, o que é API?

A API é uma ferramenta específica para usuários técnicos que desejam obter dados sem navegar pelo Portal da Transparência. Através da API, usuários podem desenvolver programas que se conectam diretamente às máquinas do Portal da Transparência e selecionam os dados desejados. Esses dados são os mesmos obtidos em tela, ou seja, os dados obtidos via API podem também ser obtidos via consultas em tela pelos usuários não técnicos.

Em uma analogia com o mundo real, a API pode ser vista como um carro sem motorista. O carro está lá com todos os recursos disponíveis e um manual que ensina como ele deve ser utilizado. Seguindo as instruções, você pode ir para onde quiser (no caso de dados, pedir os dados que quiser). O uso do Portal sem API seria como um motorista de aplicativo ou um taxi. Nesse carro, o motorista se apresenta e você fala o caminho que quer ir (o dado que quer obter). É o motorista (no caso, o site), o responsável por guiar o carro e te levar ao local desejado (fornecer o dado).

Em outra analogia, a API pode ser vista como um quadro em branco com as tintas, pincéis e materiais necessários para fazer qualquer pintura. A navegação pelo site, ou seja, sem o uso da API, seria uma exposição de quadros onde existem quadros prontos dos melhores pintores. Você escolhe a pintura ou as pinturas que mais agradam. Com a vantagem de que, no Portal da Transparência, você não paga nada pelas diversas formas de visualização dos dados oferecidas.

Exemplos

Os dados dos serviços disponibilizados na API de dados deverão ser consumidos via requisições HTTP aos serviços REST.A API está documentada http://hml.tennisup.com.br:7777/v1/swagger-ui/index.html

Termos de uso

A API de dados do Portal da Transparência é de livre utilização.


TCE