| 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 |
Lista dos inscritos em dívida ativa, contendo informações sobre data de inscrição, exercício, tipo de débito, nome do devedor, número de inscrição, valor total, situação quanto ao ajuizamento e ordem de exibição, em conformidade com o artigo 198 parágrafo 3º inciso II da Lei 5172 de 1966 os dados são disponibilizados em formato JSON com as seguintes chaves: DIV_DATA_INSCRICAO, EXE_ANO, TIPO, PES_NOME, INSCRICAO, VL_TOTAL, DIV_SITUACAO_AJUIZADO, ORDEM. |
TEXTO |
—
|
| Dicionário de Dados |
CREATE TABLE DIVIDA_ATIVA (DIV_DATA_INSCRICAO DATE NOT NULL, EXE_ANO INT NOT NULL, TIPO VARCHAR(50) NOT NULL, PES_NOME VARCHAR(255) NOT NULL, INSCRICAO VARCHAR(50) NOT NULL, VL_TOTAL DECIMAL(18,2) NOT NULL, DIV_SITUACAO_AJUIZADO VARCHAR(50) NOT NULL, ORDEM INT NOT NULL); |
TEXTO |
—
|
| Página do Portal da Transparência |
Acesso ao Conjunto de dados pelo Portal da Transparência do Município. |
HTML |
Acessar
|
