Übersicht
Die Kickscale API ermöglicht dir den Zugriff auf Kundengespräche aus deinem Arbeitsbereich.
Du kannst Meetings und Telefonate nach Datum, Kundendomäne oder ID abfragen.
Zusätzlich kannst du Telefonate direkt in Kickscale hochladen.
API Grundlagen
Die Kickscale API ist unter folgender URL erreichbar:
Base URL: https://api.kickscale.com
Swagger Dokumentation: https://api.kickscale.com/swagger
Wir empfehlen, mit der Swagger Dokumentation zu starten.
Dort findest du alle verfügbaren Endpunkte, Parameter und Beispielanfragen.
Authentifizierung
Jede Anfrage an die API muss authentifiziert werden.
Ohne gültige Header wird die Anfrage abgelehnt.
Erforderliche HTTP Header
Jede Anfrage muss folgende Header enthalten:
api-key– Dein persönlicher API Keyclient-id– Deine Kickscale Client-ID
Du findest beide dieser Werte unter Einstellungen → Integrationen → API & Webhooks in der Kickscale Plattform.
Behandle diese Zugangsdaten vertraulich.
Speichere sie nicht öffentlich oder im Quellcode.
API-Keys verwalten
Sie können Ihre API-Keys in der Kickscale-Plattform erstellen und löschen, wenn du über die Rolle „Konfigurator“ oder „Administrator“ verfügst. Die Einstellungen findest du unter Einstellungen → Integrationen → API & Webhooks.
Hier findest du auch die Client-ID welche als Header required ist.
API-Keys sind für ein Jahr gültig
Der API-Key wird nur 1x direkt nach dem Erstellen angezeigt, er kann danach nichtmehr angezeigt werden.
Du kannst so viele API-Keys wie du willst erstellen, wir empfehlen aber mit nur einem zu arbeiten
Verfügbare API Funktionen
Meetings abfragen
Du kannst Meetings aus Kickscale abrufen.
Unterstützte Filter sind:
Datumsbereich
Kundendomäne
Meeting ID
Telefonate abfragen
Telefonate können mit denselben Filteroptionen abgefragt werden.
Unterstützte Filter sind:
Datumsbereich
Kundendomäne
Call ID
Telefonate hochladen
Über die API kannst du Telefonate direkt in Kickscale hochladen.
Typische Anwendungsfälle sind:
Telefonate aus nicht unterstützten Tools
Import historischer Telefonate
Eigene Telefonie-Systeme
Hochgeladene Telefonate werden in Kickscale analysiert und liefern Einblicke.
Nutzung der Swagger Dokumentation
Die Swagger Oberfläche ist der beste Einstieg in die API.
Sie hilft dir dabei:
Alle Endpunkte zu entdecken
Pflichtfelder und Parameter zu verstehen
Anfragen direkt im Browser zu testen
Tipps & Best Practices
Starte mit einfachen Leseanfragen zum Testen.
Nutze kleine Datumsbereiche bei ersten Abfragen.
Implementiere saubere Fehlerbehandlung.
Vermeide fest codierte Zugangsdaten.
Troubleshooting
Authentifizierungsfehler
Stelle sicher, dass api-key und client-id korrekt gesetzt sind.
Unerwartete Antworten
Überprüfe Parameter und Request-Struktur in der Swagger Dokumentation.
Keine Daten gefunden
Prüfe, ob für den Zeitraum oder die Domäne Meetings oder Telefonate existieren.
Bei Unklarheiten zum Verhalten eines Endpunkts hilft die Swagger Dokumentation weiter.