Passer au contenu principal

​
Introduction

L’API Véhicules fournit des endpoints complets pour gérer votre inventaire tout au long du cycle de vie du véhicule, de la mise en ligne initiale à la vente finale. Cela inclut la gestion des données véhicules, le suivi des dommages, la coordination des inspections et les mises à jour de statut.

​
Fonctionnalités clés

Gestion d'inventaire

Créez, mettez à jour, recherchez et filtrez votre inventaire avec des capacités de recherche avancées

Suivi des dommages

Enregistrez et gérez les évaluations de dommages avec des rapports détaillés et des estimations de coûts

Intégration d'inspection

Connectez-vous aux services d’inspection IA pour la détection automatique des dommages

Workflow de statut

Suivez les véhicules via les statuts : LOADING, INSPECTED, SOLD avec un historique complet

​
Cycle de vie du véhicule

​
Endpoints API

​
Gestion des véhicules

EndpointMéthodeDescription
/vehiclesGETLister tous les véhicules avec filtres et pagination
/vehicles/{id}GETRécupérer les détails d’un véhicule par ID
/vehiclesPOSTCréer un nouveau véhicule
/vehicles/{id}PATCHMettre à jour les informations d’un véhicule
/vehicles/{id}DELETESupprimer un véhicule

​
Recherche et filtrage

EndpointMéthodeDescription
/vehicles/publicGETRécupérer les véhicules publiés publics
/vehicles/status/{status}GETFiltrer par statut d’achat
/vehicles/make/{make}GETFiltrer par marque
/vehicles/location/{location}GETFiltrer par localisation
/vehicles/search/{q}GETRecherche plein texte sur les véhicules

​
Gestion des dommages

EndpointMéthodeDescription
/vehicles/{id}/completePUTCompléter les données avec dommages et analytics
/vehicles/{id}/damagesPOSTAjouter un dommage à un véhicule
/vehicles/{id}/damages/{damageId}DELETESupprimer un dommage
/vehicles/{id}/estimate-damagesPOSTDéclencher l’estimation IA des dommages

​
Workflow d’inspection

EndpointMéthodeDescription
/vehicles/phase/preprocess/{id}POSTAssocier un job de pré-traitement au véhicule
/vehicles/webhooks/ml-resultsPOSTWebhook pour résultats du traitement ML

​
Schéma de l’objet véhicule

{
  "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"
}

​
Paramètres de requête

​
Options de filtrage

Tous les endpoints de liste prennent en charge les filtres suivants :
  • search - Recherche globale sur marque, modèle, localisation
  • make - Filtrer par marque
  • model - Filtrer par modèle
  • minPrice / maxPrice - Filtrer par plage de prix
  • minYear / maxYear - Filtrer par plage d’année
  • minKm / maxKm - Filtrer par plage de kilométrage
  • fuel - Filtrer par type de carburant
  • gearBox - Filtrer par type de transmission
  • location - Filtrer par localisation
  • purchaseStatus - Filtrer par statut (LOADING, INSPECTED, SOLD)
  • published - Filtrer par statut de publication
  • archive - Filtrer par statut d’archivage

​
Pagination et tri

  • page - Numéro de page (par défaut : 1)
  • limit - Éléments par page (par défaut : 10, max : 100)
  • sortBy - Champ de tri (price, overviewYear, km, createdAt)
  • sortOrder - Sens de tri (asc, desc)

​
Workflow de statut d’achat

​
Transitions de statut

1

LOADING

Le véhicule est en cours d’ajout à l’inventaire. Les images et les détails sont collectés.
2

INSPECTED

Le véhicule a été inspecté. Les rapports de dommages et les évaluations d’état sont terminés.
3

SOLD

Le véhicule est vendu. Transaction finalisée.

​
Schéma de l’objet dommage

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

​
Niveaux de gravité

  • minor - Dommage cosmétique, réparation minimale
  • moderate - Dommage visible nécessitant une réparation professionnelle
  • severe - Dommage structurel nécessitant des travaux importants

​
Limites de débit

Les endpoints de l’API Véhicules suivent les limites standards :
PlanRequêtes/heureLimite burst
Free1,00050
Starter10,000200
Professional100,0001,000
EnterpriseUnlimitedCustom

​
Codes d’erreur

CodeDescription
VEHICLE_NOT_FOUNDL’ID véhicule n’existe pas
VEHICLE_ALREADY_SOLDImpossible de modifier un véhicule vendu
UNAUTHORIZED_VEHICLE_ACCESSL’utilisateur ne possède pas ce véhicule
INVALID_PURCHASE_STATUSTransition de statut invalide
DUPLICATE_IMMATRICULELa plaque d’immatriculation existe déjà

​
Bonnes pratiques

Assurez-vous que tous les champs requis sont fournis et valides. Utilisez la validation du schéma pour éviter les erreurs.
Pour les inventaires de 1000+ véhicules, utilisez toujours la pagination avec des tailles de page raisonnables (10-50).
Les annonces publiques de véhicules sont mises en cache 5 minutes. Utilisez cela pour optimiser les performances.
Conservez des journaux d’audit des changements de statut pour la conformité et l’analyse métier.

​
Étapes suivantes

Lister les véhicules

Apprenez à récupérer et filtrer votre inventaire de véhicules

Créer un véhicule

Ajoutez de nouveaux véhicules à votre inventaire

Gestion des dommages

Gérez les rapports de dommages et les estimations

Recherche et filtres

Options avancées de recherche et filtrage