Ativa o contraste alto para melhor visualização.
Ativa uma fonte especial para facilitar a leitura.
Aumenta o tamanho da fonte dos textos.
Reduz o tamanho da fonte dos textos.
Navegue rapidamente com o teclado ou clique.
Esta documentação descreve os endpoints disponíveis na API e como utilizá-los.
http://api.portalmodelo.com.br:3000/api/v1
Todas as requisições devem incluir o token no header:
Authorization Bearer dA2seUDPwOaAbXSge2E/legislacao
Lista todas as legislações com filtros.
| Campo | Tipo | Descrição |
|---|---|---|
| busca | string | Termo para busca |
| por_pagina | integer | Itens por página (default: 10) |
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
}'
/legislacao/detalhe
Retorna detalhes de uma legislação específica.
| Campo | Tipo | Descrição |
|---|---|---|
| id | integer | ID da legislação |
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
Lista todos os contratos com filtros.
| Campo | Tipo | Descrição |
|---|---|---|
| busca | string | Termo para busca |
| ano | integer | Ano do contrato |
| situacao | string | Status do contrato (ativo/inativo) |
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"
}'
/contratos/detalhe
Retorna detalhes de um contrato específico.
| Campo | Tipo | Descrição |
|---|---|---|
| id | integer | ID do contrato |
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
Lista todas as obras com filtros.
| 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) |
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"
}'
/obras/detalhe
Retorna detalhes de uma obra específica.
| Campo | Tipo | Descrição |
|---|---|---|
| id | integer | ID da obra |
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
}'
{
"success": true/false,
"message": "Mensagem descritiva",
"data": {
// Dados da resposta
},
"pagination": {
"total": 100,
"per_page": 10,
"current_page": 1,
"last_page": 10
}
}
| 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 |