API für Lead-Management - Steer Autos Documentation

Überblick

Die Lead-Management-API hilft Ihnen, potenzielle Verkaufschancen für jedes Fahrzeug in Ihrem Bestand zu verfolgen und zu verwalten. Erstellen Sie umsetzbare Aufgaben, setzen Sie Prioritäten und überwachen Sie den Lead-Status im gesamten Vertriebstrichter.

Endpunkte

Alle Leads auflisten

GET

endpoint

/leads

Ruft alle Leads mit optionaler Filterung und Sortierung ab. Query-Parameter:

string

Globale Suche über action, targetName, tag

status

enum

Filter nach Status: NEW, COMPLETED, NOT_NEEDED

action

string

Filter nach Aktionstyp

targetName

string

Filter nach Zielname

tag

string

Filter nach Tag

carId

string

Filter nach zugeordneter Fahrzeug-ID

sortBy

enum

Sortierfeld: order, status, action, targetName, createdAt

sortOrder

enum

Sortierrichtung: asc, desc

Response:

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

Lead nach ID abrufen

GET

endpoint

/leads/

Ruft detaillierte Informationen zu einem bestimmten Lead ab. Path-Parameter:

string

erforderlich

Lead-UUID

Response:

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

Lead für Fahrzeug erstellen

POST

endpoint

/leads/car/

Erstellt einen neuen Lead für ein bestimmtes Fahrzeug. Path-Parameter:

carId

string

erforderlich

Fahrzeug-UUID

Request Body:

{
  "action": "Schedule test drive",
  "targetName": "Jane Doe",
  "targetInfo": "[email protected]",
  "tag": "Test Drive",
  "note": "Prefers weekend appointments",
  "status": "NEW",
  "order": 1
}

action

string

erforderlich

Aktionsbeschreibung (max. 200 Zeichen)

targetName

string

erforderlich

Name des Lead-Kontakts (max. 200 Zeichen)

targetInfo

string

erforderlich

Kontaktinformation – Telefon oder E-Mail (max. 500 Zeichen)

tag

string

Lead-Kategorietag (max. 100 Zeichen)

note

string

Zusätzliche Notizen (max. 1000 Zeichen)

status

enum

Lead-Status: NEW (Standard), COMPLETED, NOT_NEEDED

order

integer

Anzeigereihenfolge für Sortierung (Standard: 0)

Response:

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

Lead aktualisieren

PATCH

endpoint

/leads/

Aktualisiert einen bestehenden Lead. Path-Parameter:

string

erforderlich

Lead-UUID

Request Body:

{
  "status": "COMPLETED",
  "note": "Test drive completed. Customer very interested."
}

Alle Felder sind optional. Nur übermittelte Felder werden aktualisiert. Response:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "COMPLETED",
  "note": "Test drive completed. Customer very interested.",
  "updatedAt": "2024-01-16T14:20:00Z"
}

Leads für Fahrzeug abrufen

GET

endpoint

/leads/car/

Ruft alle Leads ab, die einem bestimmten Fahrzeug zugeordnet sind. Path-Parameter:

carId

string

erforderlich

Fahrzeug-UUID

Query-Parameter: Gleiche Filter- und Sortieroptionen wie beim /leads-Endpunkt. Response: Array von Lead-Objekten, standardmäßig nach Reihenfolge sortiert.

Leads nach Status abrufen

GET

endpoint

/leads/status/

Filtert Leads nach ihrem aktuellen Status. Path-Parameter:

status

enum

erforderlich

Status: NEW, COMPLETED, NOT_NEEDED

Response: Array von Leads, die dem Status entsprechen.

Leads neu sortieren

PATCH

endpoint

/leads/car//reorder

Aktualisiert die Reihenfolge der Leads eines Fahrzeugs im Bulk. Path-Parameter:

carId

string

erforderlich

Fahrzeug-UUID

Request Body:

{
  "leadOrders": [
    { "id": "lead_id_1", "order": 1 },
    { "id": "lead_id_2", "order": 2 },
    { "id": "lead_id_3", "order": 3 }
  ]
}

Response:

{
  "success": true,
  "message": "Leads reordered successfully"
}

Lead-Reihenfolge aktualisieren

PATCH

endpoint

/leads//order

Aktualisiert die Reihenfolge eines einzelnen Leads. Path-Parameter:

string

erforderlich

Lead-UUID

Request Body:

{
  "order": 5
}

Lead löschen

DELETE

endpoint

/leads/

Löscht einen Lead dauerhaft. Path-Parameter:

string

erforderlich

Lead-UUID

Response:

{
  "success": true,
  "message": "Lead deleted successfully"
}

Lead-Status-Ablauf

NEW

Lead wird erstellt und erfordert eine Aktion. Dies ist der Standardstatus.

COMPLETED

Aktion wurde erfolgreich abgeschlossen. Lead hat sein Ziel erreicht.

NOT_NEEDED

Lead ist nicht mehr relevant oder wurde abgebrochen.

Anwendungsfälle

Beispiel 1: Testfahrt-Anfragen verfolgen

# Create test drive lead
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"
  }'

Beispiel 2: Nachfassanruf verfolgen

# Create follow-up lead
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"
  }'

Beispiel 3: Dokumentenprüfung

# Create document review lead
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"
  }'

Fehlercodes

Code	Status	Beschreibung
`LEAD_NOT_FOUND`	404	Lead-ID existiert nicht
`CAR_NOT_FOUND`	404	Zugehöriges Fahrzeug nicht gefunden
`UNAUTHORIZED_LEAD_ACCESS`	403	Benutzer hat keinen Zugriff auf diesen Lead
`INVALID_LEAD_STATUS`	400	Ungültiger Statuswert angegeben
`VALIDATION_ERROR`	400	Validierung des Request Bodys fehlgeschlagen

Bewährte Praktiken

Aussagekräftige Aktionen verwenden

Beschreibungen sollten klar und umsetzbar sein. Gut: “Follow up call about financing”. Schlecht: “Call”.

Tags zur Organisation nutzen

Verwenden Sie konsistente Tags im gesamten Unternehmen: “Hot Lead”, “Test Drive”, “Documentation”, “Follow-up”.

Notizen aktuell halten

Ergänzen Sie nach jeder Interaktion Notizen, um Kontext und Verlauf zu bewahren.

Leads nach Priorität sortieren

Nutzen Sie das Feld order zur Priorisierung. Niedrigere Zahlen erscheinen zuerst.

Abgeschlossene Leads bereinigen

Archivieren oder löschen Sie abgeschlossene Leads regelmäßig, um die Pipeline sauber zu halten.

Integrationstipps

Die Leads-API integriert sich nahtlos mit:

Vehicles API – Leads automatisch mit dem Bestand verknüpfen
CRM-Systemen – Leads in externe CRM-Plattformen exportieren
E-Mail/SMS-Diensten – Benachrichtigungen bei Statusänderungen auslösen
Analytics – Conversion-Raten und Lead-Performance verfolgen

CRM-Integrationsleitfaden

Erfahren Sie mehr über CRM-Integration und bewährte Praktiken

API-Dokumentation

​Überblick

​Endpunkte

​Alle Leads auflisten

​Lead nach ID abrufen

​Lead für Fahrzeug erstellen

​Lead aktualisieren

​Leads für Fahrzeug abrufen

​Leads nach Status abrufen

​Leads neu sortieren

​Lead-Reihenfolge aktualisieren

​Lead löschen

​Lead-Status-Ablauf

​Anwendungsfälle

​Beispiel 1: Testfahrt-Anfragen verfolgen

​Beispiel 2: Nachfassanruf verfolgen

​Beispiel 3: Dokumentenprüfung

​Fehlercodes

​Bewährte Praktiken

​Integrationstipps

CRM-Integrationsleitfaden

Überblick

Endpunkte

Alle Leads auflisten

Lead nach ID abrufen

Lead für Fahrzeug erstellen

Lead aktualisieren

Leads für Fahrzeug abrufen

Leads nach Status abrufen

Leads neu sortieren

Lead-Reihenfolge aktualisieren

Lead löschen

Lead-Status-Ablauf

Anwendungsfälle

Beispiel 1: Testfahrt-Anfragen verfolgen

Beispiel 2: Nachfassanruf verfolgen

Beispiel 3: Dokumentenprüfung

Fehlercodes

Bewährte Praktiken

Integrationstipps