Passer au contenu principal

​
Aperçu

L’API de gestion des prospects vous aide à suivre et gérer les opportunités de vente potentielles pour chaque véhicule de votre inventaire. Créez des tâches actionnables, définissez des priorités et surveillez le statut des prospects tout au long du tunnel de vente.

​
Endpoints

​
Lister tous les prospects

​
GET
endpoint
/leads
Récupère tous les prospects avec filtrage et tri optionnels. Paramètres de requête :
​
search
string
Recherche globale sur action, targetName, tag
​
status
enum
Filtrer par statut : NEW, COMPLETED, NOT_NEEDED
​
action
string
Filtrer par type d’action
​
targetName
string
Filtrer par nom de la cible
​
tag
string
Filtrer par tag
​
carId
string
Filtrer par ID de véhicule associé
​
sortBy
enum
Champ de tri : order, status, action, targetName, createdAt
​
sortOrder
enum
Sens du tri : asc, desc
Réponse : 
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "carId": "car_uuid",
    "status": "NEW",
    "action": "Follow up call",
    "targetName": "John Smith",
    "targetInfo": "+212-600-123456",
    "tag": "Hot Lead",
    "note": "Customer interested in financing options",
    "order": 1,
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z",
    "car": {
      "id": "car_uuid",
      "make": "Honda",
      "model": "Civic",
      "overviewYear": 2021,
      "location": "Casablanca"
    }
  }
]

​
Récupérer un prospect par ID

​
GET
endpoint
/leads/
Récupère les informations détaillées d’un prospect spécifique. Paramètres de chemin :
​
id
string
requis
UUID du prospect
Réponse : 
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "carId": "car_uuid",
  "status": "NEW",
  "action": "Follow up call",
  "targetName": "John Smith",
  "targetInfo": "+212-600-123456",
  "tag": "Hot Lead",
  "note": "Customer interested in financing options",
  "order": 1,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

​
Créer un prospect pour un véhicule

​
POST
endpoint
/leads/car/
Crée un nouveau prospect associé à un véhicule spécifique. Paramètres de chemin :
​
carId
string
requis
UUID du véhicule
Corps de la requête : 
{
  "action": "Schedule test drive",
  "targetName": "Jane Doe",
  "targetInfo": "[email protected]",
  "tag": "Test Drive",
  "note": "Prefers weekend appointments",
  "status": "NEW",
  "order": 1
}
​
action
string
requis
Description de l’action (max 200 caractères)
​
targetName
string
requis
Nom du contact (max 200 caractères)
​
targetInfo
string
requis
Informations de contact - téléphone ou email (max 500 caractères)
​
tag
string
Tag de catégorie du prospect (max 100 caractères)
​
note
string
Notes supplémentaires (max 1000 caractères)
​
status
enum
Statut du prospect : NEW (par défaut), COMPLETED, NOT_NEEDED
​
order
integer
Ordre d’affichage pour le tri (par défaut : 0)
Réponse : 
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "carId": "car_uuid",
  "status": "NEW",
  "action": "Schedule test drive",
  "targetName": "Jane Doe",
  "targetInfo": "[email protected]",
  "tag": "Test Drive",
  "note": "Prefers weekend appointments",
  "order": 1,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

​
Mettre à jour un prospect

​
PATCH
endpoint
/leads/
Met à jour les informations d’un prospect existant. Paramètres de chemin :
​
id
string
requis
UUID du prospect
Corps de la requête : 
{
  "status": "COMPLETED",
  "note": "Test drive completed. Customer very interested."
}
Tous les champs sont facultatifs. Seuls les champs fournis seront mis à jour. Réponse : 
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "COMPLETED",
  "note": "Test drive completed. Customer very interested.",
  "updatedAt": "2024-01-16T14:20:00Z"
}

​
Récupérer les prospects d’un véhicule

​
GET
endpoint
/leads/car/
Récupère tous les prospects associés à un véhicule spécifique. Paramètres de chemin :
​
carId
string
requis
UUID du véhicule
Paramètres de requête : Mêmes options de filtrage et tri que l’endpoint /leads. Réponse : Tableau d’objets prospect triés par ordre (croissant par défaut).

​
Récupérer les prospects par statut

​
GET
endpoint
/leads/status/
Filtrer les prospects par statut actuel. Paramètres de chemin :
​
status
enum
requis
Statut : NEW, COMPLETED, NOT_NEEDED
Réponse : Tableau d’objets prospect correspondant au statut.

​
Réordonner les prospects

​
PATCH
endpoint
/leads/car//reorder
Met à jour en lot les positions d’ordre des prospects pour un véhicule. Paramètres de chemin :
​
carId
string
requis
UUID du véhicule
Corps de la requête : 
{
  "leadOrders": [
    { "id": "lead_id_1", "order": 1 },
    { "id": "lead_id_2", "order": 2 },
    { "id": "lead_id_3", "order": 3 }
  ]
}
Réponse : 
{
  "success": true,
  "message": "Leads reordered successfully"
}

​
Mettre à jour l’ordre d’un prospect

​
PATCH
endpoint
/leads//order
Met à jour la position d’ordre d’un prospect. Paramètres de chemin :
​
id
string
requis
UUID du prospect
Corps de la requête : 
{
  "order": 5
}

​
Supprimer un prospect

​
DELETE
endpoint
/leads/
Supprime définitivement un prospect. Paramètres de chemin :
​
id
string
requis
UUID du prospect
Réponse : 
{
  "success": true,
  "message": "Lead deleted successfully"
}

​
Workflow de statut des prospects

1

NEW

Le prospect est créé et nécessite une action. Statut par défaut.
2

COMPLETED

L’action a été menée à bien. Le prospect a atteint son objectif.
3

NOT_NEEDED

Le prospect n’est plus pertinent ou a été annulé.

​
Cas d’usage

​
Exemple 1 : Suivre les demandes d’essai

# Créer un prospect d'essai
curl -X POST "https://api.steerai.autos/v1/leads/car/{carId}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "Schedule test drive",
    "targetName": "Ahmed Benali",
    "targetInfo": "+212-600-123456",
    "tag": "Test Drive",
    "note": "Prefers Saturday morning"
  }'

​
Exemple 2 : Suivre les appels de relance

# Créer un prospect de relance
curl -X POST "https://api.steerai.autos/v1/leads/car/{carId}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "Follow-up call",
    "targetName": "Sara Alami",
    "targetInfo": "[email protected]",
    "tag": "Hot Lead",
    "note": "Interested in financing. Call back Tuesday"
  }'

​
Exemple 3 : Revue de documents

# Créer un prospect de revue documentaire
curl -X POST "https://api.steerai.autos/v1/leads/car/{carId}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "Prepare sales documents",
    "targetName": "Legal Department",
    "targetInfo": "[email protected]",
    "tag": "Documentation"
  }'

​
Codes d’erreur

CodeStatutDescription
LEAD_NOT_FOUND404L’ID prospect n’existe pas
CAR_NOT_FOUND404Véhicule associé introuvable
UNAUTHORIZED_LEAD_ACCESS403Accès non autorisé à ce prospect
INVALID_LEAD_STATUS400Statut invalide fourni
VALIDATION_ERROR400Validation du corps de requête échouée

​
Bonnes pratiques

Rédigez des descriptions claires et actionnables. Bien : “Follow up call about financing”. Mauvais : “Call”.
Utilisez des tags cohérents : “Hot Lead”, “Test Drive”, “Documentation”, “Follow-up”.
Ajoutez des notes après chaque interaction pour conserver le contexte et l’historique.
Utilisez le champ order pour prioriser les prospects. Les plus petits numéros apparaissent en premier.
Archivez ou supprimez régulièrement les prospects terminés pour garder un pipeline propre.

​
Conseils d’intégration

L’API Leads s’intègre parfaitement avec :
  • API Véhicules - Lier automatiquement les prospects à l’inventaire
  • Systèmes CRM - Exporter les prospects vers des CRM externes
  • Services Email/SMS - Déclencher des notifications sur les changements de statut
  • Analytics - Suivre les taux de conversion et la performance des prospects

Guide d'intégration CRM

En savoir plus sur l’intégration CRM et les bonnes pratiques