Dados Abertos

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.

Publicação gradual

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.

Regras de utilização

Antes de integrar sistemas externos a esta API, consulte as Regras de Utilização da API de Dados Abertos, que descrevem o limite técnico de requisições, a exigência de citação da fonte e as demais condições de uso.

Dados abertos Informações públicas em formato acessível, estruturado e reutilizável.

API Interface para consulta automatizada por aplicações, painéis e integrações.

Documentação Referência de parâmetros, filtros, campos de retorno e exemplos de uso.

Categorias

Módulos da documentação

A navegação abaixo apresenta a organização prevista para os conjuntos de dados abertos do portal.

Contratos Disponível Licitações Disponível Servidores Disponível Legislação Disponível Convênios Disponível

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

API - Contratos

Consulta pública de contratos

Endpoint aberto para consulta dos contratos publicados, com filtro opcional por ano do contrato.

URL https://dev.portal.varanda.dev.br/api/contratos

Método 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.
`vig?ncia_inicial`	DATA	Data inicial da vigência no formato AAAA-MM-DD.
`vig?ncia_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://dev.portal.varanda.dev.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",
            "vig?ncia_inicial": "2024-04-24",
            "vig?ncia_final": "2024-07-24",
            "valor": "41157.88"
        }
    ]
}

API - Licitações

Licitações

Consulta pública das licitações publicadas, com filtro opcional por ano do exercício.

URL https://dev.portal.varanda.dev.br/api/licitacoes

Método 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 exercício da licitação.

Retorno

Nome	Tipo	Descrição
`ano`	INT	Ano do exercício da licitação.
`numero`	VARCHAR	Número da licitação.
`numero_processo`	VARCHAR	Número do processo administrativo.
`data_publicacao`	DATA	Data de publicação no formato AAAA-MM-DD.
`data_licitacao`	DATA	Data da licitação no formato AAAA-MM-DD.
`modalidade`	VARCHAR	Modalidade da licitação.
`situacao`	VARCHAR	Situação da licitação.
`entidade`	VARCHAR	Órgão responsável pela licitação.
`objeto`	TEXT	Objeto da licitação.
`valor_estimado`	DECIMAL	Valor estimado com duas casas decimais.
`valor_certame`	DECIMAL	Valor do certame com duas casas decimais.

Como usar

URL utilizada:

https://dev.portal.varanda.dev.br/api/licitacoes?ano=2024

Exemplo de retorno

{
    "Licitacoes": [
        {
            "ano": 2024,
            "numero": "001/2024",
            "numero_processo": "1234/2024",
            "data_publicacao": "2024-01-10",
            "data_licitacao": "2024-02-01",
            "modalidade": "Pregão",
            "situacao": "Homologado",
            "entidade": "Prefeitura Municipal de Arapiraca",
            "objeto": "Aquisição de materiais.",
            "valor_estimado": "100000.00",
            "valor_certame": "95000.00"
        }
    ]
}

API - Servidores

Servidores

Consulta pública de servidores e remunerações, com CPF sempre mascarado.

URL https://dev.portal.varanda.dev.br/api/servidores

Método GET

Parâmetros obrigatórios

Não necessita de parâmetro obrigatório.

Parâmetros opcionais

Nome	Tipo	Descrição
`ano`	INT (4)	Ano de referência da folha.
`mes`	INT	Mês de referência da folha, de 1 a 12.

Retorno

Nome	Tipo	Descrição
`nome`	VARCHAR	Nome do servidor.
`cpf`	VARCHAR	CPF mascarado.
`matricula`	VARCHAR	Matrícula do servidor.
`cargo`	VARCHAR	Cargo ocupado.
`orgao`	VARCHAR	Órgão de lotação.
`tipo_vinculo`	VARCHAR	Tipo de vínculo.
`carga_horaria`	INT	Carga horária semanal.
`situacao`	VARCHAR	Situação funcional.
`salario_bruto`	DECIMAL	Remuneração bruta com duas casas decimais.
`salario_liquido`	DECIMAL	Remuneração líquida com duas casas decimais.
`mes`	INT	Mês de referência da folha.
`ano`	INT	Ano de referência da folha.

Como usar

URL utilizada:

https://dev.portal.varanda.dev.br/api/servidores?ano=2024&mes=6

Exemplo de retorno

{
    "Servidores": [
        {
            "nome": "JOAO SILVA",
            "cpf": "***.456.7**-**",
            "matricula": "12345",
            "cargo": "Analista",
            "orgao": "Secretaria de Administração",
            "tipo_vinculo": "Efetivo",
            "carga_horaria": 40,
            "situacao": "Ativo",
            "salario_bruto": "5000.00",
            "salario_liquido": "4000.00",
            "mes": 6,
            "ano": 2024
        }
    ]
}

API - Legislação

Legislação

Consulta pública da legislação publicada, com filtro opcional por ano.

URL https://dev.portal.varanda.dev.br/api/legislacao

Método GET

Parâmetros obrigatórios

Não necessita de parâmetro obrigatório.

Parâmetros opcionais

Nome	Tipo	Descrição
`ano`	INT (4)	Ano ou exercício da legislação.

Retorno

Nome	Tipo	Descrição
`tipo`	VARCHAR	Tipo de legislação.
`numero`	VARCHAR	Número da legislação.
`nome`	VARCHAR	Nome ou título da legislação.
`descricao`	VARCHAR	Ementa ou descrição.
`ano`	INT	Ano ou exercício.
`data`	DATA	Data no formato AAAA-MM-DD, quando disponível.

Como usar

URL utilizada:

https://dev.portal.varanda.dev.br/api/legislacao?ano=2024

Exemplo de retorno

{
    "Legislacao": [
        {
            "tipo": "Lei",
            "numero": "001/2024",
            "nome": "Lei Exemplo",
            "descricao": "Ementa da legislação.",
            "ano": 2024,
            "data": "2024-01-10"
        }
    ]
}

API - Convênios

Convênios

Consulta pública dos convênios publicados, com filtro opcional por ano da assinatura.

URL https://dev.portal.varanda.dev.br/api/convenios

Método GET

Parâmetros obrigatórios

Não necessita de parâmetro obrigatório.

Parâmetros opcionais

Nome	Tipo	Descrição
`ano`	INT (4)	Ano da assinatura do convênio.

Retorno

Nome	Tipo	Descrição
`numero_convenio`	VARCHAR	Número do convênio.
`objeto`	TEXT	Objeto do convênio.
`objeto_detalhado`	TEXT	Detalhamento do objeto.
`orgao_concedente`	VARCHAR	Órgão concedente.
`orgao_convenente`	VARCHAR	Órgão convenente.
`data_assinatura`	DATA	Data de assinatura no formato AAAA-MM-DD.
`data_inicio_vigencia`	DATA	Início da vigência no formato AAAA-MM-DD.
`data_fim_vigencia`	DATA	Fim da vigência no formato AAAA-MM-DD.
`valor_total`	DECIMAL	Valor total com duas casas decimais.
`valor_repasse`	DECIMAL	Valor do repasse com duas casas decimais.
`valor_contra_partida`	DECIMAL	Valor da contrapartida com duas casas decimais.
`tipo`	VARCHAR	Tipo de instrumento.
`situacao`	VARCHAR	Situação do convênio.

Como usar

URL utilizada:

https://dev.portal.varanda.dev.br/api/convenios?ano=2024

Exemplo de retorno

{
    "Convenios": [
        {
            "numero_convenio": "001/2024",
            "objeto": "Objeto do convênio.",
            "objeto_detalhado": "Detalhamento do objeto.",
            "orgao_concedente": "Órgão concedente",
            "orgao_convenente": "Órgão convenente",
            "data_assinatura": "2024-01-10",
            "data_inicio_vigencia": "2024-01-15",
            "data_fim_vigencia": "2024-12-31",
            "valor_total": "100000.00",
            "valor_repasse": "90000.00",
            "valor_contra_partida": "10000.00",
            "tipo": "Convênio",
            "situacao": "Vigente"
        }
    ]
}

Dados Abertos

Regras de Utilização

Condições de acesso, reutilização e limites técnicos para o consumo automatizado dos dados abertos do Portal da Transparência.

1. Natureza pública dos dados

Os dados disponibilizados pelos endpoints públicos do Portal da Transparência (Contratos, Licitações, Servidores, Legislação e Convênios) são informações de caráter público, oriundas da execução da transparência ativa municipal, e podem ser livremente consultados, copiados, distribuídos e reutilizados, respeitadas as regras descritas a seguir e a legislação de proteção de dados pessoais aplicável (dados sensíveis, como o CPF de servidores, são disponibilizados de forma mascarada).

2. Citação da fonte

Ao reutilizar, republicar ou incorporar os dados em outros sistemas, painéis, pesquisas ou publicações, é exigida a citação da fonte como "Portal da Transparência de Arapiraca", preferencialmente com indicação do endpoint utilizado e da data da consulta.

3. Limite técnico de requisições

Para preservar a estabilidade do serviço e o acesso equânime de todos os consumidores, cada endpoint da API pública está sujeito a um limite técnico de 120 requisições por minuto, por endereço IP. Requisições que excedam esse limite recebem resposta HTTP 429 (Too Many Requests) e devem ser reenviadas após o intervalo indicado na resposta.

4. Disponibilidade do serviço

A API é mantida em regime de melhor esforço. Não há garantia de disponibilidade ininterrupta (24x7), podendo ocorrer indisponibilidades temporárias para manutenção, atualização de dados ou correção de falhas, sem aviso prévio.

5. Qualidade, atualização e reprocessamento dos dados

Os dados publicados podem ser reprocessados, corrigidos ou atualizados a qualquer momento pela administração municipal, em razão de retificações administrativas, correções de erro material ou atualização de registros. Recomenda-se que sistemas consumidores não tratem os dados como definitivos e verifiquem periodicamente eventuais alterações.

6. Uso responsável

É vedado o uso da API para fins que violem a legislação vigente, que tentem contornar os limites técnicos de acesso, ou que exponham indevidamente dados pessoais além do que já é disponibilizado publicamente pelo Portal.

7. Canal de contato

Dúvidas, sugestões ou solicitações relacionadas ao uso da API de dados abertos podem ser encaminhadas pelos canais de Ouvidoria ou E-SIC do Portal da Transparência.