ACESSIBILIDADE
Acesso automatizado (API)
Em cumprimento ao Art. 8º, §3º, III da Lei de Acesso à Informação (Lei nº 12.527/2011), este portal disponibiliza acesso automatizado aos dados públicos, por meio de APIs (Application Programming Interface), utilizando formatos abertos, estruturados e legíveis por máquina.
As APIs possibilitam que qualquer cidadão, empresa ou sistema consulte os dados de forma transparente, segura e eficiente.
Cabeçalho (Header) Obrigatório
Para utilização das APIs em ferramentas de acesso automatizado, é obrigatório incluir o seguinte header HTTP
nas requisições:
['X-NucleoGov-Services: true']
Sem este cabeçalho, as requisições não serão processadas.
Estrutura Organizacional
Consulta das unidades da estrutura organizacional.
Método de Requisição: GET
URL e rota: https://beta.nucleogov.com.br/api/estrutura_organizacional
Parâmetros:| Índice | Descrição | Obrigatoriedade | Tipo de dado |
|---|---|---|---|
| acao | Valor fixo: "listar_relacao" | Obrigatório | Textual |
| unidade_id | Identificador da unidade, para consulta de uma única unidade e unidades subordinadas | Opcional | Número Inteiro |
| search | Radical de busca textual. Exemplo: "Saúde" | Opcional | Textual |
Status 200 - JSON com dados do retorno
Ouvidoria
Obtenção do relatório estatístico de manifestações recebidas pela Ouvidoria.
Método de Requisição: GET
URL e rota: https://beta.nucleogov.com.br/api/ouvidoria
Parâmetros:| Índice | Descrição | Obrigatoriedade | Tipo de dado |
|---|---|---|---|
| acao | Valor fixo: "relatorio" | Obrigatório | Textual |
| data_inicial | Data Inicial de referência para a consulta | Se não informado será usado 01 de janeiro do exercício anterior | Data: aaaa-mm-dd |
| data_final | Data Final de referência para a consulta | Se não informado será usado 31 de dezembro do exercício anterior | Data: aaaa-mm-dd |
Status 200 - JSON com dados do retorno
Plano de Contratações Anual (PCA)
Consulta de dados consolidados sobre Plano de Contratações Anual (PCA).
Método de Requisição: GET
URL e rota: https://beta.nucleogov.com.br/api/plano_contratacoes_anual_tcm
Parâmetros:| Índice | Descrição | Obrigatoriedade | Tipo de dado |
|---|---|---|---|
| acao | Valor fixo: "listar" | Obrigatório | Textual |
| limit | Quantidade de registros que será listado | Se não informado, será listado 15 registros | Textual: offset ex: "0,15" |
| txtbusca | Busca textual na Descrição | Opcional | Textual |
| area | Área do PCA | Opcional | Textual |
| ano | Ano do PCA | Opcional | Número Inteiro |
Status 200 - JSON com dados do retorno
Acompanhamento de Obras
Consulta de dados consolidados sobre Acompanhamento de Obras.
Método de Requisição: GET
URL e rota: https://beta.nucleogov.com.br/api/obras_tcm
Parâmetros:| Índice | Descrição | Obrigatoriedade | Tipo de dado |
|---|---|---|---|
| acao | Valor fixo: "listar" | Obrigatório | Textual |
| limit | Quantidade de registros que será listado | Se não informado, será listado 15 registros | Textual: offset ex: "0,15" |
| id | Identificador da Obra | Opcional | Número Inteiro |
| txtbusca | Busca textual na Descrição | Opcional | Textual |
| situacao | Situação da Obra | Opcional | Textual |
| valor_min | Valor Previsto Mínimo do Contrato | Opcional | Moeda Brl: 1.000.000,00 |
| valor_max | Valor Previsto Máximo do Contrato | Opcional | Moeda Brl: 10.000.000,00 |
Status 200 - JSON com dados do retorno