acessibilidade

Prefeitura Municipal de Iguaracu

conteúdo principal topo

Documentação da API Vale

Esta documentação descreve os endpoints disponíveis na API e como utilizá-los.

URL Base da API
http://api.portalmodelo.com.br:3000/api/v1

Autenticação

Todas as requisições devem incluir o token no header: 

Authorization Bearer stk0iXh6WwmJx5Q6JRHi

Legislação

POST /legislacao

Lista todas as legislações com filtros.

Parâmetros
Campo Tipo Descrição
busca string Termo para busca
por_pagina integer Itens por página (default: 10)
Exemplo
                    curl -X POST http://api.portalmodelo.com.br:3000/api/v1/legislacao \
                            -H "Authorization: Bearer seu-token" \
                            -H "Content-Type: application/json" \
                            -d '{
                                    "busca": "lei",
                                    "por_pagina": 10
                            }'
POST /legislacao/detalhe

Retorna detalhes de uma legislação específica.

Parâmetros
Campo Tipo Descrição
id integer ID da legislação
Exemplo
                    curl -X POST http://api.portalmodelo.com.br:3000/api/v1/legislacao/detalhe \
                            -H "Authorization: Bearer seu-token" \
                            -H "Content-Type: application/json" \
                            -d '{
                                    "id": 1
                            }'

Contratos

POST /contratos

Lista todos os contratos com filtros.

Parâmetros
Campo Tipo Descrição
busca string Termo para busca
ano integer Ano do contrato
situacao string Status do contrato (ativo/inativo)
Exemplo
curl -X POST http://api.portalmodelo.com.br:3000/api/v1/contratos \
     -H "Authorization: Bearer seu-token" \
     -H "Content-Type: application/json" \
     -d '{
         "busca": "construção",
         "ano": 2025,
         "situacao": "ativo"
     }'
POST /contratos/detalhe

Retorna detalhes de um contrato específico.

Parâmetros
Campo Tipo Descrição
id integer ID do contrato
Exemplo
curl -X POST http://api.portalmodelo.com.br:3000/api/v1/contratos/detalhe \
     -H "Authorization: Bearer seu-token" \
     -H "Content-Type: application/json" \
     -d '{
         "id": 1
     }'

Obras

POST /obras

Lista todas as obras com filtros.

Parâmetros
Campo Tipo Descrição
busca string Termo para busca no título
situacao string Status da obra (em_andamento/concluida/paralisada)
data_inicial date Data inicial (Y-m-d)
data_final date Data final (Y-m-d)
Exemplo
curl -X POST http://api.portalmodelo.com.br:3000/api/v1/obras \
     -H "Authorization: Bearer seu-token" \
     -H "Content-Type: application/json" \
     -d '{
         "busca": "pavimentação",
         "situacao": "em_andamento",
         "data_inicial": "2025-01-01"
     }'
POST /obras/detalhe

Retorna detalhes de uma obra específica.

Parâmetros
Campo Tipo Descrição
id integer ID da obra
Exemplo
curl -X POST http://api.portalmodelo.com.br:3000/api/v1/obras/detalhe \
     -H "Authorization: Bearer seu-token" \
     -H "Content-Type: application/json" \
     -d '{
         "id": 1
     }'

Formato das Respostas

{
                                "success": true/false,
                                "message": "Mensagem descritiva",
                                "data": {
                                    // Dados da resposta
                                },
                                "pagination": {
                                    "total": 100,
                                    "per_page": 10,
                                    "current_page": 1,
                                    "last_page": 10
                                }
                            }

Códigos de Status HTTP

Código Descrição
200 Sucesso
201 Criado com sucesso
400 Erro de validação
401 Não autorizado
404 Não encontrado
500 Erro interno do servidor
Índice

O site da Prefeitura não utiliza cookies e tecnologias semelhantes.

Ver Termo
Assistente Virtual