Definições da API
O acesso aos dados abertos é feito através de nossa API, que consiste em endereços na Internet (URL) prontos para serem aproveitados por outros aplicativos. É possível realizar consultas através da passagem de parâmetros, com os dados sendo disponibilizados nos formatos XML, JSON e HTML.
URL Básica
Para acessar os dados é preciso conhecer a URL básica e o formato dos parâmetros.
URL:
Onde:
- <metodo> - informações que serão consultadas (valor obrigatório)
- <formato> - formato do resultado que será apresentado (valor obrigatório)
- <campoN> - nome do filtro que será utilizado na pesquisa
- <valorN> - valor do filtro que será utilizado na pesquisa
Atenção:
- Por questões de performance, apenas os 10.000 primeiros registros são apresentados;
- Somente os dados de entrada podem ser usados para fazer consultas;
- Verifique a documentação de cada método para saber se existem parâmetros obrigatórios.
Exemplos
Abaixo são apresentados exemplos de consultas utilizando a API de Dados Abertos.
https://sistemas.tce.pe.gov.br/DadosAbertos/UnidadesJurisdicionadas!xml?NATUREZA=prefeitura
https://sistemas.tce.pe.gov.br/DadosAbertos/Fornecedores!json?CPFCNPJ=000
Recebendo a resposta
As respostas seguirão duas estruturas básicas: uma para os formatos XML e JSON, e outra para o formato HTML. O código HTTP da resposta sempre será 200, mesmo quando houver erro.
Resposta XML e JSON
<conteudo/>
</resposta>
{"resposta":
{
"status":"OK",
"entidade":"DadosFolha",
"tamanhoResultado":"0",
"limiteResultado":"10000",
"conteudo":[]
}
}
Resposta HTML e HTML Formatado
As respostas em HTML serão apresentadas como tabelas. No HTML, a primeira linha contém o nome dos campos e as demais o conteúdo. No HTML Formatado, é apresentada uma tela com a tabela e um layout CSS aplicado.
Divirta-se!
