Zum Hauptinhalt springen

API-Schlüssel

API-Schlüssel sind Bearer-Tokens, die programmatischen Zugriff auf die LeadHub-REST-API gewähren. Verwenden Sie sie, um benutzerdefinierte Integrationen zu erstellen, Daten mit anderen Systemen zu synchronisieren oder Aufgaben per Code zu automatisieren.


API-Schlüssel erstellen

  1. Gehen Sie zu Integrationen → API-Schlüssel.
  2. Klicken Sie auf Neuer API-Schlüssel.
  3. Füllen Sie aus:
FeldBeschreibung
NameBeschreibender Name (z. B. „Meine App-Integration", „Zapier")
BerechtigungenWelche Aktionen dieser Schlüssel ausführen kann (nur lesen, lesen-schreiben)
Läuft ab amOptionales Ablaufdatum; leer lassen für kein Ablaufdatum
  1. Klicken Sie auf Speichern.
  2. Kopieren Sie das Token sofort — es wird nur einmal angezeigt. Wenn Sie es verlieren, müssen Sie es regenerieren.

API-Schlüssel verwenden

Fügen Sie den Schlüssel als Bearer-Token in jede API-Anfrage ein:

GET /api/leads HTTP/1.1
Host: yourdomain.com
Authorization: Bearer YOUR_API_KEY_HERE
Content-Type: application/json

API-Endpunkte

MethodeEndpunktBeschreibung
GET/api/leadsAlle Leads auflisten (paginiert)
GET/api/leads/{id}Einen einzelnen Lead abrufen
POST/api/leadsNeuen Lead erstellen
PUT/api/leads/{id}Lead aktualisieren
DELETE/api/leads/{id}Lead löschen
GET/api/pipelinesPipelines auflisten
GET/api/tagsTags auflisten
POST/api/leads/{id}/tagsTags zu einem Lead hinzufügen

Vollständige API-Referenz in den LeadHub-Swagger-Docs unter /api/documentation auf Ihrer Installation.


Schlüssel widerrufen

Um einen API-Schlüssel zu widerrufen:

  1. Gehen Sie zu Integrationen → API-Schlüssel.
  2. Klicken Sie auf das Löschsymbol in der Schlüsselzeile und bestätigen.

Der Schlüssel wird sofort ungültig. Alle Anfragen, die ihn verwenden, erhalten eine 401-Unauthorized-Antwort.


Sicherheits-Best-Practices

  • API-Schlüssel niemals in die Versionskontrolle einbetten (GitHub, Bitbucket usw.)
  • Nur-Lese-Schlüssel verwenden, wenn Sie nur Daten lesen müssen
  • Ablaufdaten für Schlüssel setzen, die für temporäre Integrationen verwendet werden
  • Schlüssel sofort widerrufen, wenn sie möglicherweise exponiert wurden
  • Einen Schlüssel pro Integration verwenden, um spezifische unabhängig widerrufen zu können