Método HTTP GET
Autenticação: API Key + API Secret
Comparação
Encontrar veículos similares
Retorna itens similares ao veículo base.
Resumo técnico
- Método
- Método HTTP GET
- Rota
- /vehicles/{vehicle_id}/compare-similar
- URL completa
- https://uzjxyrtbszreqxjvpzpv.supabase.co/functions/v1/public-catalog-phase1/vehicles/{vehicle_id}/compare-similar
Quando usar
Use para recomendar alternativas próximas.
Headers obrigatórios
| Header | Obrigatório | Descrição | Exemplo |
|---|---|---|---|
| X-API-Key | Sim | Chave pública fornecida para consumo da API pública. | SUA_PUBLIC_KEY |
| X-API-Secret | Sim | Segredo pareado à API Key para autenticação. | SEU_SECRET |
Parâmetros de rota
| Nome | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
| vehicle_id | uuid | Sim | UUID do veículo base. | - |
Parâmetros de consulta
| Nome | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
| top | number | Não | Quantidade máxima (1-20). Padrão: 5. | 5 |
Campos principais da resposta
Retorna `data.data.items[]` no formato RankingBaseItem e `meta.filters_applied.vehicle_id/top`.
| Nome | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
| data.data.items[] | string | Não | Campo retornado pelo endpoint. | - |
| data.meta.filters_applied.vehicle_id | string | Não | Campo retornado pelo endpoint. | - |
| data.meta.filters_applied.top | string | Não | Campo retornado pelo endpoint. | - |
Cenários de uso
- Integrar este endpoint em rotinas de consulta e enriquecimento de dados automotivos.
Exemplos de integração
Os exemplos desta documentação utilizam dados fictícios/mockados para fins ilustrativos, mas seguem a estrutura oficial real da API.
Nunca exponha X-API-Secret em aplicações front-end públicas. Para aplicações web públicas, faça a chamada a partir do seu backend.
Exemplo de integração (cURL)
curl -X GET "https://uzjxyrtbszreqxjvpzpv.supabase.co/functions/v1/public-catalog-phase1/vehicles/001af754-592a-42ce-8227-01c958d4de3c/compare-similar?top=5" \
-H "X-API-Key: SUA_PUBLIC_KEY" \
-H "X-API-Secret: SEU_SECRET"Os exemplos desta documentação utilizam dados fictícios/mockados para fins ilustrativos, mas seguem a estrutura oficial real da API.
Exemplo de resposta
{
"success": true,
"data": {
"data": {
"items": [
{
"vehicleId": "001c09ef-0e8a-495f-a460-c34d00bc83f5",
"marca": "Toyota",
"modelo": "Corolla",
"ano": 2025,
"categoria": "Sedan",
"ecoScore": 70.1,
"co2ReferenciaGKm": 102,
"eficienciaMediaReferencia": 12.6
}
]
},
"meta": {
"generated_at": "2026-04-17T22:03:16.372Z",
"request_id": "762f6abe-1846-4c04-a979-e348c3e0c072",
"filters_applied": {
"vehicle_id": "001af754-592a-42ce-8227-01c958d4de3c",
"top": 5
}
}
}
}Erros possíveis (exemplo de payload)
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Parâmetros inválidos: page deve ser maior que 0"
}
}