Método HTTP GET
Autenticação: API Key + API Secret
Insights de Veículos
Posições de ranking de um veículo
Retorna posição global/categoria/combustível e percentil.
Resumo técnico
- Método
- Método HTTP GET
- Rota
- /vehicles/{vehicle_id}/ranking-positions
- URL completa
- https://uzjxyrtbszreqxjvpzpv.supabase.co/functions/v1/public-catalog-phase1/vehicles/{vehicle_id}/ranking-positions
Quando usar
Use para mostrar posição relativa em contexto de ranking.
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. | - |
Campos principais da resposta
Retorna um objeto em `data.data` com `vehicleId`, posição global, posição na categoria, posição no combustível e percentil.
| Nome | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
| data.data.vehicleId | string | Não | Campo retornado pelo endpoint. | - |
| data.data.global | string | Não | Campo retornado pelo endpoint. | - |
| data.data.naCategoria | string | Não | Campo retornado pelo endpoint. | - |
| data.data.noCombustivel | string | Não | Campo retornado pelo endpoint. | - |
| data.data.percentil | string | Não | Campo retornado pelo endpoint. | - |
Cenários de uso
- Consumir insights paginados com `data.meta.pagination`.
- Renderizar campos nullable sem inferir defaults inexistentes.
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/ranking-positions" \
-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": {
"vehicleId": "001af754-592a-42ce-8227-01c958d4de3c",
"global": 42,
"naCategoria": 8,
"noCombustivel": 11,
"percentil": 91.58
},
"meta": {
"generated_at": "2026-04-17T22:03:16.372Z",
"request_id": "762f6abe-1846-4c04-a979-e348c3e0c072"
}
}
}Erros possíveis (exemplo de payload)
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Parâmetros inválidos: page deve ser maior que 0"
}
}