Mega PEAD Locacao e Servicos

API Reference

Megapead — Documentação da API

Referência interativa dos endpoints disponíveis. Para cada rota você encontra o método HTTP, path exato, modelo de parâmetros, schema de resposta e um campo para testar a chamada em tempo real.

Nao testadolocalStorage ativocliente sem backend adicional
1.GET/api/health

Verifica se a API está online e autentica com o header x-api-key. Retorna status, nome do serviço e versão.

Parâmetros da Requisição

Headers

x-api-keystringrequiredChave de autenticação da API

Sem parâmetros de path ou query.

Modelo de Resposta

200 OK
{
  "ok": true,
  "data": {
    "status": "ok",
    "service": "megapead-api",
    "version": "1.0.0"
  }
}

Testar Agora

cURL

curl -X GET "/api/health" \
  -H "x-api-key: SUA_API_KEY"

Postman

{
  "method": "GET",
  "header": [
    {
      "key": "x-api-key",
      "value": "SUA_API_KEY",
      "type": "text"
    }
  ],
  "url": {
    "raw": "/api/health",
    "host": [
      "/api/health"
    ]
  }
}
2.GET/api/buscar

Localiza produtos por descrição ou código. A busca tolera variações simples de grafia e pronúncia para facilitar a descoberta do item correto, sem expor preços nesta rota.

Parâmetros da Requisição

Headers

x-api-keystringrequiredChave de autenticação da API

Query

qstringrequiredTermo de busca por descrição ou código— e.g. cap
limitintegeroptionalMáximo de itens retornados (1–100)— e.g. 20

Modelo de Resposta

200 OK
{
  "ok": true,
  "data": [
    {
      "codigo": "CAEF020111D",
      "descricao": "CAP EF PVC 20MM 20X1/2 C/ BUCHA LATAO",
      "origem": "nacional",
      "aliases_pesquisa": [
        "caef020111d",
        "cap ef pvc 20mm 20x1 2 c bucha latao",
        "cap",
        "bucha",
        "nacional"
      ]
    }
  ],
  "meta": {
    "q": "cap",
    "limit": 20,
    "total": 5,
    "estrategia": "codigo,texto,fuzzy-fonetico"
  }
}

Testar Agora

URL gerada

/api/buscar?q=cap&limit=20

cURL

curl -X GET "/api/buscar?q=cap&limit=20" \
  -H "x-api-key: SUA_API_KEY"

Postman

{
  "method": "GET",
  "header": [
    {
      "key": "x-api-key",
      "value": "SUA_API_KEY",
      "type": "text"
    }
  ],
  "url": {
    "raw": "/api/buscar?q=cap&limit=20",
    "host": [
      "/api/buscar?q=cap&limit=20"
    ]
  }
}
3.GET/api/produto/{codigo}

Retorna descrição, origem, preço base e distribuição de preços por todos os estados para um produto específico.

Parâmetros da Requisição

Headers

x-api-keystringrequiredChave de autenticação da API

Path

codigostringrequiredCódigo único do produto— e.g. CAEF020111D

Modelo de Resposta

200 OK
{
  "ok": true,
  "data": {
    "codigo": "CAEF020111D",
    "descricao": "CAP EF PVC 20MM 20X1/2 C/ BUCHA LATAO",
    "origem": "nacional",
    "preco_base": 4.5,
    "precos_estado": {
      "PE": 4.75,
      "SP": 4.9,
      "RJ": 4.85
    }
  }
}

Testar Agora

URL gerada

/api/produto/{codigo}

cURL

curl -X GET "/api/produto/{codigo}" \
  -H "x-api-key: SUA_API_KEY"

Postman

{
  "method": "GET",
  "header": [
    {
      "key": "x-api-key",
      "value": "SUA_API_KEY",
      "type": "text"
    }
  ],
  "url": {
    "raw": "/api/produto/{codigo}",
    "host": [
      "/api/produto/{codigo}"
    ]
  }
}
4.GET/api/produto/{codigo}/preco

Retorna o preço final calculado para um produto em uma UF específica, indicando a fonte da tabela de preços utilizada. O campo codigo tolera entradas com número da linha, descrição, hífen, sinal de + e outros ruídos desde que o código do item esteja presente.

Parâmetros da Requisição

Headers

x-api-keystringrequiredChave de autenticação da API

Path

codigostringrequiredAceita o código puro ou texto misto contendo o código do produto— e.g. 4 COT100026II COLARINHO CURTO TF PEAD DN1000 SDR26 PN6,5 II

Query

estadostring (UF)requiredSigla do estado brasileiro para cálculo do preço— e.g. PE

Modelo de Resposta

200 OK
{
  "ok": true,
  "data": {
    "codigo": "CAEF020111D",
    "descricao": "CAP EF PVC 20MM 20X1/2 C/ BUCHA LATAO",
    "estado": "PE",
    "preco": 4.75,
    "fonte_preco": "tabela_estadual"
  }
}

Testar Agora

URL gerada

/api/produto/{codigo}/preco?estado=PE

cURL

curl -X GET "/api/produto/{codigo}/preco?estado=PE" \
  -H "x-api-key: SUA_API_KEY"

Postman

{
  "method": "GET",
  "header": [
    {
      "key": "x-api-key",
      "value": "SUA_API_KEY",
      "type": "text"
    }
  ],
  "url": {
    "raw": "/api/produto/{codigo}/preco?estado=PE",
    "host": [
      "/api/produto/{codigo}/preco?estado=PE"
    ]
  }
}
5.POST/api/precos/consultar

Consulta valores de múltiplos itens depois que o agente já definiu os produtos, quantidades e a UF do cliente. Aceita estado padrão e estados por item. Retorna subtotal por linha, total geral, linhas inválidas e itens não encontrados.

Parâmetros da Requisição

Headers

x-api-keystringrequiredChave de autenticação da API

Sem parâmetros de path ou query.

Request Body (application/json)

{
  "estado": "PE",
  "itens": [
    {
      "codigo": "CAEF020111D",
      "qtd": 2
    },
    {
      "codigo": "CATF025111D",
      "qtd": 5,
      "estado": "SP"
    }
  ]
}

Modelo de Resposta

200 OK
{
  "ok": true,
  "data": {
    "estado": "PE",
    "total": 33.25,
    "itens": [
      {
        "codigo": "CAEF020111D",
        "descricao": "CAP EF PVC",
        "qtd": 2,
        "estado": "PE",
        "preco_unitario": 4.75,
        "subtotal": 9.5,
        "fonte_preco": "tabela_estadual"
      }
    ],
    "nao_encontrados": []
  }
}

Testar Agora

cURL

curl -X POST "/api/precos/consultar" \
  -H "x-api-key: SUA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "estado": "PE",
  "itens": [
    {
      "codigo": "CAEF020111D",
      "qtd": 2
    },
    {
      "codigo": "CATF025111D",
      "qtd": 5,
      "estado": "SP"
    }
  ]
}'

Postman

{
  "method": "POST",
  "header": [
    {
      "key": "x-api-key",
      "value": "SUA_API_KEY",
      "type": "text"
    },
    {
      "key": "Content-Type",
      "value": "application/json",
      "type": "text"
    }
  ],
  "url": {
    "raw": "/api/precos/consultar",
    "host": [
      "/api/precos/consultar"
    ]
  },
  "body": {
    "mode": "raw",
    "raw": "{\n  \"estado\": \"PE\",\n  \"itens\": [\n    {\n      \"codigo\": \"CAEF020111D\",\n      \"qtd\": 2\n    },\n    {\n      \"codigo\": \"CATF025111D\",\n      \"qtd\": 5,\n      \"estado\": \"SP\"\n    }\n  ]\n}",
    "options": {
      "raw": {
        "language": "json"
      }
    }
  }
}
Estado padrão para itens sem UF própria. Se um item tiver estado preenchido, ele substitui o padrão.