Dados Abertos

Com o intúito de dar maior transparência às ações do tribunal e tornar mais eficaz a fiscalização dos recursos públicos por parte da sociedade, o TCE/MA está abrindo os seus dados públicos através de sua API(Interface de Programação de Aplicativos)

A API permite que qualquer programa de computador, independentemente da plataforma utilizada ,tenha acesso fácil aos dados disponibilizados e que os interessados possam construir suas próprias aplicações para os mais diversos propósitos

Sobre a API

A API foi desenvolvida sobre o modelo Restfull utilizando a linguagem de programação JAVA e o framework Spring, e os dados são retornados em formato JSON.

Conhecendo os Endpoints

Todos os endpoints disponibilizados pela API estão disponíveis e acessíveis através do Swegger na url:

http://app.tce.ma.gov.br:8889/swagger-ui.html

Além de listar os endpoints também é possível ver quais parâmetros de busca o endpoint suporta e também pre-visualizar os dados retornados e realizar testes

Solicitando os Dados

Para solicitar qualquer informação através da API, basta informar a URL base(http://app.tce.ma.gov.br:8889) e adicionar o final da url o endpoint desejado. Por exemplo, para retornar todas as remessas enviadas pelo sistema FINGER basta acessar a seguite url:

http://app.tce.ma.gov.br:8889/remessas

A maioria dos endpoints permitem consultar passando parâmetros, para passar um parâmetro para a busca basta adicionar o caractere "?" ao final da url. Por exemplo, ainda utilizando a url anterior, mas agora eu quero retornar todas as remessas, mas apenas do ente Estado do Maranhão:

http://app.tce.ma.gov.br:8889/remessas?enteId=1

Os parâmetros também podem ser combinados, você pode combinar todos os parâmetros de consulta que uma url suportar, para tanto basta adicionar um "&" após informar o primeiro parâmetro. Por exemplo, se eu quiser agora todas as remessas do ente Estado do Maranhão, mas quero agora apenas as remessas referentes ao exercício 2018:

http://app.tce.ma.gov.br:8889/remessas?enteId=1&exercicio=2018

Para facilitar a manipuação das informações a API também suporta paginação, a paginação é controlada pelos parâmetros page e size, sendo que mesmo quando os parâmetros de paginação não são enviados na url, o parâmetro page recebe o valor padrão zero e o parâmetro size recebe o valor padrão dez.

Onde Conseguir os Parâmetros Pré Definidos?

Alguns parâmetros são pré-definidos, pois são códigos utilizados internamente pelos sistemas informatizados do TCE/MA, como por exemplo o parâmetro enteId que foi utilizado nos exemplos anteriores, esse valor é utilizado por diversos sistemas internos e o valor enteId=1 aponta para o ente Estado do Maranhão. os parâmetros enteId, orgaoId e unidadeId também podem ser chamados de "identificadores TCE", são eles que identificam os Entes, Órgãos e Unidades cadastradas no banco de dados do TCE/MA e podem ser consultados no endereço:

https://www6.tce.ma.gov.br/PCA/visualizarestrutura.zul

Existem outros valores padrões para parâmetros como por exemplo os identificadores para as modalidades de licitação, que também são utilizados internamente pelos sistemas do TCE/MA. Observando o Swagger você vai notar que existe um endpoint que lista os valores suportados para este parâmetro específico:

http://app.tce.ma.gov.br:8889/modalidadesLicitacao

Buscar em Notícias

Diário Oficial Eletrônico

Dezembro 2019
D S
1 2 3 4 5 6 7
8 9 10 11 12 13 14
15 16 17 18 19 20 21
22 23 24 25 26 27 28
29 30 31 1 2 3 4