| 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, para serem utilizados por programas, aplicativos web e outros sistemas, por meio de linguagens de programação como JavaScript, C#, Java, entre outras. Em termos simples, uma API funciona como uma ponte de comunicação entre diferentes sistemas, permitindo que eles troquem informações de forma padronizada, segura e automática. Ela define como um sistema pode ser acessado por outro, especificando quais informações estão disponíveis, como devem ser solicitadas e em qual formato serão entregues. As APIs são amplamente utilizadas para integrar sistemas, automatizar processos e compartilhar funcionalidades e dados entre plataformas, promovendo eficiência, interoperabilidade e inovação tecnológica. Como exemplo, disponibilizamos um link público para demonstrar o consumo do serviço com os parâmetro ANO definido. Para mais detalhes sobre como consumir este e outros serviços, consulte a documentação para consumo de API disponível na seção Recursos. |
JSON |
Acessar
|
| Documentação para Consumo da 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 os 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
|
| Metadados |
Documentação referente ao uso de APIs voltadas para Dados Abertos. Os dados são apresentados em formato JSON com as seguintes chaves: API_NOME, API_ORIGEM, Entrada, Esperado, Erro, EndPoint, API_COD, API_DATA, NOME_ARQUIVO, URL_JSON, API_METADADOS, API_DICIONARIO, URL_RELATORIO. |
TEXTO |
—
|
| Dicionário de Dados |
CREATE TABLE TSP_API_VI (API_NOME VARCHAR(500), API_ORIGEM VARCHAR(500), Entrada VARCHAR(500), Esperado VARCHAR(500), Erro VARCHAR(500), EndPoint VARCHAR(500), API_COD INT, API_DATA DATE, NOME_ARQUIVO VARCHAR(500), URL_JSON VARCHAR(500), API_METADADOS VARCHAR(500), API_DICIONARIO VARCHAR(500), URL_RELATORIO VARCHAR(500)); |
TEXTO |
—
|
| Página do Portal da Transparência |
Acesso ao Conjunto de dados pelo Portal da Transparência do Município. |
HTML |
Acessar
|
