Saltar al contenido principal

​
Introduccion

La API de vehiculos ofrece endpoints completos para gestionar tu inventario a lo largo del ciclo de vida del vehiculo, desde el alta inicial hasta la venta final. Incluye gestion de datos, seguimiento de danos, coordinacion de inspecciones y actualizaciones de estado.

​
Funcionalidades clave

Gestion de inventario

Crea, actualiza, busca y filtra tu inventario con capacidades avanzadas de busqueda

Seguimiento de danos

Registra y gestiona evaluaciones de danos con reportes detallados y estimacion de costos

Integracion de inspecciones

Conecta con inspecciones con IA para deteccion automatica de danos

Workflow de estados

Seguimiento de estados: LOADING, INSPECTED, SOLD con historial completo

​
Ciclo de vida del vehiculo

​
Endpoints de la API

​
Gestion de vehiculos

EndpointMethodDescripcion
/vehiclesGETLista todos los vehiculos con filtros y paginacion
/vehicles/{id}GETObtiene detalles de un vehiculo por ID
/vehiclesPOSTCrea un vehiculo nuevo
/vehicles/{id}PATCHActualiza informacion del vehiculo
/vehicles/{id}DELETEElimina un vehiculo

​
Busqueda y filtros

EndpointMethodDescripcion
/vehicles/publicGETObtiene vehiculos publicos publicados
/vehicles/status/{status}GETFiltra por estado de compra
/vehicles/make/{make}GETFiltra por marca
/vehicles/location/{location}GETFiltra por ubicacion
/vehicles/search/{q}GETBusqueda de texto completo

​
Gestion de danos

EndpointMethodDescripcion
/vehicles/{id}/completePUTCompleta datos con danos y analitica
/vehicles/{id}/damagesPOSTAgrega dano al vehiculo
/vehicles/{id}/damages/{damageId}DELETEElimina dano
/vehicles/{id}/estimate-damagesPOSTDispara estimacion de danos con IA

​
Flujo de inspeccion

EndpointMethodDescripcion
/vehicles/phase/preprocess/{id}POSTAdjunta job de preprocesamiento
/vehicles/webhooks/ml-resultsPOSTWebhook de resultados de ML

​
Esquema de objeto vehiculo

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "userId": "user_uuid",
  "make": "Honda",
  "model": "Civic",
  "overviewYear": 2021,
  "price": 25000,
  "km": 45000,
  "location": "Casablanca, Morocco",
  "seat": 5,
  "gearBox": "Automatic",
  "fuel": "Gasoline",
  "engineDisplacement": 1800,
  "numberCV": 140,
  "averageConsumption": "6.5L/100km",
  "outside": "Excellent",
  "inside": "Good",
  "ownerNumber": 1,
  "purchaseStatus": "INSPECTED",
  "archive": false,
  "published": true,
  "adNumber": 12345,
  "immatricule": "ABC-1234",
  "overviewImgs": "https://...",
  "postedBy": "Dealer XYZ",
  "functionalities": "GPS, Bluetooth, Cruise Control",
  "feature": "Sunroof, Leather Seats",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

​
Parametros de consulta

​
Opciones de filtrado

Todos los endpoints de listado soportan estos filtros:
  • search - Busqueda global por marca, modelo, ubicacion
  • make - Filtra por marca
  • model - Filtra por modelo
  • minPrice / maxPrice - Rango de precio
  • minYear / maxYear - Rango de ano
  • minKm / maxKm - Rango de kilometraje
  • fuel - Filtra por combustible
  • gearBox - Filtra por transmision
  • location - Filtra por ubicacion
  • purchaseStatus - Filtra por estado (LOADING, INSPECTED, SOLD)
  • published - Filtra por estado de publicacion
  • archive - Filtra por estado de archivo

​
Paginacion y ordenamiento

  • page - Numero de pagina (default: 1)
  • limit - Items por pagina (default: 10, max: 100)
  • sortBy - Campo de orden (price, overviewYear, km, createdAt)
  • sortOrder - Direccion (asc, desc)

​
Flujo de estado de compra

​
Transiciones de estado

1

LOADING

Se esta agregando el vehiculo al inventario. Se recopilan imagenes y detalles.
2

INSPECTED

Vehiculo inspeccionado. Reportes de danos y condicion completos.
3

SOLD

Vehiculo vendido. Transaccion completada.

​
Esquema de objeto dano

{
  "id": "damage_uuid",
  "type": "Dent",
  "severity": "moderate",
  "location": "Front Right Door",
  "description": "Small dent approximately 5cm diameter",
  "estimatedCost": 350,
  "imageUrls": [
    "https://...",
    "https://..."
  ]
}

​
Niveles de severidad

  • minor - Dano cosmetico, reparacion minima
  • moderate - Dano visible que requiere reparacion profesional
  • severe - Dano estructural que requiere trabajo significativo

​
Limites de tasa

Los endpoints de vehiculos siguen los limites estandar:
PlanSolicitudes/HoraLimite de rafaga
Free1,00050
Starter10,000200
Professional100,0001,000
EnterpriseUnlimitedCustom

​
Codigos de error

CodeDescripcion
VEHICLE_NOT_FOUNDEl ID del vehiculo no existe
VEHICLE_ALREADY_SOLDNo se puede modificar un vehiculo vendido
UNAUTHORIZED_VEHICLE_ACCESSEl usuario no es propietario
INVALID_PURCHASE_STATUSTransicion de estado invalida
DUPLICATE_IMMATRICULELa placa ya existe

​
Mejores practicas

Asegura que los campos requeridos sean validos. Usa validacion de esquema para evitar errores.
Para inventarios de 1000+ vehiculos, usa paginacion con tamanos razonables (10-50).
Los listados publicos se cachean por 5 minutos. Usalo para optimizar rendimiento.
Mantén auditorias de cambios de estado para cumplimiento y BI.

​
Siguientes pasos

Listar vehiculos

Aprende a obtener y filtrar tu inventario

Crear vehiculo

Agrega nuevos vehiculos a tu inventario

Gestion de danos

Gestiona reportes y estimaciones de danos

Busqueda y filtros

Opciones avanzadas de busqueda y filtrado