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 |
Total das despesas empenhadas, liquidadas e pagas. Fundamentação: Arts. 7º, VI e 8º, §1º, inciso III, da Lei nº 12.527/2011 - LAI; arts. 48, §1º, inciso II e 48-A, inciso I, da LC nº 101/20; art. 8º, inciso I, do Decreto nº 10.540/20.
Os campos exibidos das despesas são:
emp_processo_completo,
cpf_cnpj_formatada, tipo,
valor_estornado,
ano,
objeto,
valor_despesa,
valor_despesa_total,
dotacao,
descricao_favorecido,
unidade_orcamentaria,
natureza_despeza,
fonte,
funcao,
subfuncao,
orgao,
modalidade_licitacao,
data_despesa,
nome_secretria,
empenho,
op,
codigo_interno,
nr_op,
despesa,
numero_licitacao,
catagoria_economica,
catagoria_descricao,
grupo_despesa,
grupo_descricao,
elemento_despesa,
descricao_elemento_despesa,
acao,
programa,
valor_liquidado,
valor_estorno_liquidacao,
valor_retido,
valor_estorno_pagamento,
valor_pago_liquido,
estorno_do_empenho |
TEXTO |
—
|
Dicionário de Dados |
CREATE TABLE [dbo].[TB_LAI_EMPENHO_TODOS_VI](
[Cod_tipo] [int] NOT NULL,
[Despesa] [varchar](500) NULL,
[codigo_interno] [int] NOT NULL,
[OP] [int] NULL,
[ANO] [int] NULL,
[valor_despesa] [numeric](18, 2) NULL,
[valor_despesa_total] [numeric](18, 2) NULL,
[data_despesa] [datetime] NULL,
[dotacao] [varchar](1000) NULL,
[obs] [varchar](1) NOT NULL,
[tipo_favorecido] [int] NOT NULL,
[descricao_favorecido] [varchar](500) NOT NULL,
[cpfcnpj_favorecido] [varchar](8000) NULL,
[empenho] [int] NOT NULL,
[status] [int] NOT NULL,
[unidade_orcamentaria] [varchar](200) NULL,
[numero_secretaria] [varchar](1000) NULL,
[nome_secretria] [varchar](500) NULL,
[secretaria] [varchar](250) NULL,
[natureza_despeza] [varchar](500) NULL,
[fonte] [varchar](1000) NULL,
[funcao] [varchar](300) NULL,
[subfuncao] [varchar](300) NULL,
[orgao] [varchar](200) NULL,
[modalidade_licitacao] [varchar](1000) NULL,
[EMP_PROCESSO_ADM] [varchar](100) NULL,
[ANO_COD_PROCESSO] [int] NULL,
[Estorno_do_Empenho] [varchar](3) NOT NULL,
[ACAO] [varchar](1000) NULL,
[PROGRAMA] [varchar](1000) NULL,
[ORG_TIPO] [varchar](2) NULL,
[numero_licitacao] [varchar](1000) NULL,
[processo_licitacao] [varchar](1000) NULL,
[processo_dispensa_licitacao] [varchar](1000) NULL,
[numero_contrato] [varchar](1000) NULL,
[aditivo_contrato] [varchar](500) NULL,
[valor_liquidado] [numeric](18, 2) NULL,
[valor_estorno_liquidacao] [numeric](18, 2) NULL,
[valor_retido] [numeric](18, 2) NULL,
[valor_pago_liquido] [numeric](18, 2) NULL,
[valor_estorno_pagamento] [numeric](18, 2) NULL,
[catagoria_economica] [varchar](1) NULL,
[catagoria_descricao] [varchar](500) NULL,
[grupo_despesa] [varchar](2) NULL,
[grupo_descricao] [varchar](1000) NULL,
[elemento_despesa] [varchar](6) NULL,
[descricao_elemento_despesa] [varchar](1000) NULL,
[Objeto] [varchar](max) NULL,
[data_ultima] [datetime] NOT NULL
) ON [PRIMARY] TEXTIMAGE_ON [PRIMARY] |
TEXTO |
—
|
Página do Portal da Transparência |
Acesso as Informações sobre os gastos públicos realizados pelo município pelo Portal da Transparência do Município. |
HTML |
Acessar
|