Esta versão está obsoleta! Acesse a nova API de Dados Abertos.
O TCE/CE mais uma vez transforma o óbvio em realidade: abrimos os dados. Só que agora de uma maneira diferente, estamos possibilitando que programas de computador acessem os dados facilmente. O TCE/CE está disponibilizando os dados do SIM via Interface de Programação de Aplicativos (ou API ). Acreditamos na criatividade coletiva e através dela temos a certeza que a comunidade tem condições de criar suas próprias aplicações fazendo uso dos dados da meneira que melhor lhe convier. E para isso, nada melhor que facilitar a criação desses aplicativos. Buscamos estabelecer contato com desenvolvedores interessados em criar seus próprios aplicativos usando os dados do TCE/CE, veja a seguir como.
O acesso aos dados aberto é feito através de nossa API, que consiste em endereços na Internet(url) onde os dados são disponibilizados em formatos XML, JSON, CSV e HTML. Prontos para serem aproveitados por outros aplicativos. Além disso, é possível realizar consulta através da passagem de parâmetros.
Para acessar os dados é preciso conhecer o endereço ou url básica.
https://api.tce.ce.gov.br/index.php/sim/1_0/<metodo>.<formato>?<campo1>=<valor1>&<campo2>=<valor2>
Utilizando a URL BÁSICA, para solicitar qualquer dado através da API, dois parâmetros são necessários: <metodo> e <formato>. O método indica qual informação você deseja e o define sua preferência em receber a resposta em HTML, XML, JSON ou CSV. Consulta nossa documentação para saber quais os métodos disponíveis. Os parâmetros campo e valor são utilizados para filtrar os registros retornados pelos métodos. Atenção: por questões de performance, não é permitido listar TODOS OS DADOS através de alguns métodos. Verifique a documentação de cada método para saber que parâmetros são obrigatórios. A seguir temos dois exemplos de uso da API.
Exemplo 1: Para listar todos os municipios no formato XML utilize a seguinte url
https://api.tce.ce.gov.br/sim/1_0/municipios.xml
Exemplo 2: Para listar todos os negociantes, em formato XML, que tem a palavra 'gasolina' no nome.
https://api.tce.ce.gov.br/sim/1_0/negociantes.xml?nome_negociante=gasolina
As respostas seguirão duas estruturas básicas: uma para os formatos XML e JSON, e outra para os formatos HTML e CSV. O código HTTPs da resposta sempre será 200, mesmo quando houver erro.
<rsp stat="ok">
<!-- conteudo -->
</rsp>
"rsp": {
"_content": {
/* conteudo */
},
"stat": "ok"
}
Tanto as respostas em HTML quanto em CSV serão apresentadas como tabelas, onde a primeira linha contem o nome dos campos e as demais o conteúdo.
O download dos dados abertos é feito através de nossa API. Podem ser acessados a partir dos métodos disponíveis obedecendo os critérios previamente estabelecidos. Os métodos disponibilizam os dados em tempo real e em vários formatos conforme visto anteriormente.