API |
A API (sigla para Application Programming Interface, em português Interface de Programação de Aplicações) é uma ferramenta que permite a extração e o compartilhamento de dados armazenados em bancos de dados, possibilitando sua utilização por programas, aplicações web e outros sistemas, por meio de linguagens de programação como JavaScript, C#, Java, entre outras. De forma simplificada, uma API funciona como uma ponte de comunicação entre diferentes sistemas, permitindo que eles troquem informações de maneira padronizada, segura e automatizada. Ela define as regras de acesso entre sistemas, especificando quais informações estão disponíveis, como devem ser solicitadas e em qual formato serão entregues (geralmente em JSON ou XML). As APIs são amplamente utilizadas para: Integrar sistemas heterogêneos; Automatizar processos; Compartilhar funcionalidades e dados entre plataformas. Dessa forma, promovem maior eficiência, interoperabilidade e inovação tecnológica. Disponibilizamos um link público para demonstrar o consumo deste serviço via método HTTP GET, com o parâmetro ANO definido como exemplo, observação: o método oficial de consumo em ambiente de produção é o POST. Para mais informações sobre este e outros serviços, consulte a documentação técnica disponível na seção Recursos, onde são detalhadas as instruções para autenticação, parâmetros, formatos de resposta e exemplos de uso. |
JSON |
Acessar
|
Documentação para Consumo da API |
A documentação para consumo de API (Interface de Programação de Aplicações) é um guia técnico que descreve como acessar e utilizar os serviços digitais oferecidos por uma API. No contexto de dados abertos, ela funciona como um manual que permite que desenvolvedores, analistas e sistemas externos se conectem automaticamente aos dados públicos disponibilizados pela entidade. Essa documentação contém informações essenciais como: Endereços (URLs) dos serviços; Métodos de requisição (GET, POST, etc.); Parâmetros de entrada e saída; Formatos dos dados retornados (JSON, XML); Exemplos de uso. |
JSON |
Acessar
|
Metadados |
Título: Ferramenta de Pesquisa de Conteúdo do Portal da Transparência. Descrição: Recurso de busca que permite consultar e acessar informações publicadas no Portal da Transparência, facilitando a obtenção de dados públicos por meio de critérios como palavras-chave, categorias e descrições. A ferramenta atende aos princípios da transparência ativa, conforme previsto no Art. 8º, § 3º, inciso I, da Lei nº 12.527/2011 (Lei de Acesso à Informação – LAI), garantindo ao cidadão o direito de acesso claro e estruturado às informações públicas. Formato de Retorno: Os resultados são disponibilizados em formato JSON, com as seguintes chaves: link_sitemap: URL de referência do conteúdo encontrado. BUSCA: Termo ou expressão consultada. Categoria: Classificação temática da informação. QT: Quantidade de ocorrências relacionadas à acessos ao item. Percentual: Representação percentual relativa ao total de acessos ao item. ANO: Ano da consulta. |
TEXTO |
—
|
Dicionário de Dados |
CREATE TABLE Resultado_Busca_Avancada (link_sitemap NVARCHAR(500), BUSCA NVARCHAR(255), Categoria NVARCHAR(255), Descricao NVARCHAR(MAX), QT INT, Percentual NVARCHAR(50), ANO INT); |
TEXTO |
—
|
Página do Portal da Transparência |
Acesso ao Conjunto de dados pelo Portal da Transparência do Município. |
HTML |
Acessar
|