Boas-vindas
Esta área reúne orientações para acesso, consulta e reutilização dos dados públicos disponibilizados pelo Município.
Dados abertos são informações públicas disponibilizadas em formatos que permitem consulta, análise, compartilhamento e reutilização por qualquer pessoa. Essa prática fortalece a transparência ativa, amplia o controle social e facilita o uso dos dados por cidadãos, órgãos de controle, pesquisadores e desenvolvedores.
As APIs públicas permitem que sistemas, painéis e aplicações consultem informações de forma padronizada. Cada módulo documentado apresenta a descrição do conjunto de dados, os filtros aceitos, os campos de retorno, os formatos disponíveis e exemplos de requisição, observadas as regras de proteção de dados pessoais.
A documentação será organizada por módulos temáticos. A primeira área contemplada é Contratos, e os demais conjuntos de dados serão incorporados conforme homologação técnica e disponibilidade das informações.
Módulos da documentação
A navegação abaixo apresenta a organização prevista para os conjuntos de dados abertos do portal.
Contratos
A seção de Contratos concentra a documentação sobre contratos administrativos publicados no Portal da Transparência, com descrição do conjunto de dados, critérios de consulta, campos de retorno e exemplos de uso.
- Status
- Disponível
- Formato
- JSON
- Endpoint
- /api/contratos
Consulta pública de contratos
Endpoint aberto para consulta dos contratos publicados, com filtro opcional por ano do contrato.
https://transparencia.arapiraca.al.gov.br/api/contratos
GET
Parâmetros obrigatórios
Não necessita de parâmetro obrigatório.
Parâmetros opcionais
| Nome | Tipo | Descrição |
|---|---|---|
ano |
INT (4) | Ano do contrato a ser consultado. |
Retorno
| Nome | Tipo | Descrição |
|---|---|---|
ano |
INT | Ano do contrato. |
data |
DATA | Data do contrato no formato AAAA-MM-DD. |
numero |
VARCHAR | Número do contrato. |
modalidade |
VARCHAR | Modalidade da licitação vinculada ao contrato. |
objeto |
VARCHAR | Objeto do contrato. |
fornecedor |
VARCHAR | Fornecedor do contrato. |
cnpj |
VARCHAR | CNPJ do fornecedor, ou CPF mascarado quando o fornecedor for pessoa física. |
vigencia_inicial |
DATA | Data inicial da vigência no formato AAAA-MM-DD. |
vigencia_final |
DATA | Data final da vigência no formato AAAA-MM-DD. |
valor |
DECIMAL | Valor do contrato com duas casas decimais. |
Como usar
URL utilizada:
https://transparencia.arapiraca.al.gov.br/api/contratos?ano=2024
Exemplo de retorno
{
"Contratos": [
{
"ano": 2024,
"data": "2024-04-24",
"numero": "03",
"modalidade": "DISPENSA DE LICITAÇÃO",
"objeto": "FORNECIMENTO DE MATERIAIS PARA ATENDER AS NECESSIDADES DA ADMINISTRAÇÃO MUNICIPAL.",
"fornecedor": "EMPRESA EXEMPLO LTDA",
"cnpj": "12.345.678/0001-90",
"vigencia_inicial": "2024-04-24",
"vigencia_final": "2024-07-24",
"valor": "41157.88"
}
]
}