Zum Hauptinhalt springen

So verwendest Du die Online-API-Dokumentation

A
Verfasst von Anna-Maria Samuelsson
Heute aktualisiert

Unsere Online-Dokumentation ist interaktiv gestaltet, damit Du Endpunkte erkunden, Echtzeit-Beispiele ansehen und sogar Anfragen direkt in Deinem Browser testen kannst.

Die offizielle technische Referenz für die Leadfeeder-API findest Du unter https://docs.leadfeeder.com/api/public.

Navigation in der Dokumentation

Die Dokumentation ist in einem dreispaltigen Layout organisiert, um Dir den besten Überblick über unsere Dienste zu geben:

  • Linke Seitenleiste: Hier kannst Du die verfügbaren Endpunkte durchsuchen, die nach Kategorien (z. B. Firmen, Kontakte, Web-Besuche, Listen usw.) gruppiert sind.

  • Mittlere Spalte: Hier findest Du detaillierte Beschreibungen der einzelnen Endpunkte, einschließlich der erforderlichen Parameter, Header und Datentypen.

  • Rechte Seitenleiste: Hier siehst Du Live-Beispiele für Anfragen und Antworten in verschiedenen Programmiersprachen.

Interaktive Funktionen

Damit Du schnell loslegen kannst, enthält die Dokumentation mehrere interaktive Tools:

  • „Ausprobieren“-Funktion: Du kannst echte API-Aufrufe direkt von der Dokumentationsseite ausführen, um genau zu sehen, welche Daten zurückgegeben werden.

  • Code-Schnipsel: Generiere automatisch Code für Deine Anfragen in Sprachen wie Python, JavaScript, Ruby und mehr.

  • Antwort: Sieh Dir das genaue JSON-Schema für jede Antwort an, um sicherzustellen, dass Deine Anwendung die Daten korrekt verarbeitet.

Authentifizierung in der Dokumentation

Um die „Ausprobieren“-Funktion zu nutzen, musst Du zuerst Deine Anmeldedaten und Parameter eingeben:

  • Gib Deinen API-Schlüssel ein: Gib im Abschnitt „Anmeldedaten“ Dein gültiges API-Token in das Feld „X-Api-Key“ ein.

  • Gib Deine Pfadparameter an: Einige Endpunkte erfordern Pfadparameter, wie z. B. eine ID. Gib den entsprechenden Wert im Abschnitt „Pfadparameter“ ein.

Hat dies deine Frage beantwortet?