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âmetros ANO e MÊS definidos. 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 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 |
Receita Prevista x Arrecadada. Fundamentação: Art. 8º, II, "e", do Decreto nº 10.540/2020.
Os campos exibidos da consulta receitas prevista x arrecadada são:
PLA_CODIGO,
VALOR_ORÇADO,
VALOR_MES,
VALOR_ATE_MES,
Diferença,
ANO_COD,
MES_COD,
PLA_NOME_NIVEL |
TEXTO |
—
|
Dicionário de Dados |
CREATE TABLE [dbo][VS_ROTGPC_CONSOLIDADO](
[PLA_CODIGO] [VARCHAR](50) NULL,
[VALOR_ORÇADO] [NUMERIC](20,2) NULL,
[VALOR_MES] [NUMERIC](20,2) NULL,
[VALOR_ATE_MES] [NUMERIC](20,2) NULL,
[Diferença] [NUMERIC](20,2) NULL,
[ANO_COD] [int] NULL
[MES_COD] [int] NULL
[PLA_NOME_NIVEL] [varchar](500) NULL
) |
TEXTO |
—
|
Página do Portal da Transparência |
Acesso aos Dados sobre os valores arrecadados pelo Portal da Transparência do Município. |
HTML |
Acessar
|