Die API mit einem API-Schlüssel nutzen

Mit der API nutzen Sie Ihre Bots aus Ihrer eigenen Software heraus: einem Intranet, einer App oder einem CRM. Sie stellen Fragen an einen Bot, rufen Leads ab oder passen Inhalte an, ohne das Portal zu öffnen.

Was können Sie mit der API tun?

• Ihre Bots abfragen und einem Bot eine Frage stellen, auch mit Streaming. Sie können ein Gespräch abrufen und fortsetzen.
• Mit Zugriff auf Leads: Leads, Beschwerden und Fehlermeldungen abrufen, die Nachverfolgung anpassen, Reservierungen einsehen und direkt reservieren, Gespräche auflisten und Webhooks einrichten.
• Mit Inhalte verwalten: Angebotformulare, Reservierungen (auch Schließungstage), FAQs und Quellen anpassen.
• Mit Darf Bots erstellen: neue Bots erstellen. Jeder Bot hat einen eigenen Plan, daher kostet ein zusätzlicher Bot Geld. Der Aufrufer muss diesen Preis bestätigen.
• Zahlen und Einblicke eines Bots abfragen.

Alle Aufrufe mit Beispielen in curl, JavaScript und Python finden Sie in der API-Dokumentation.

Einen API-Schlüssel erstellen

1. Gehen Sie im Menü zu Verbindungen → API-Schlüssel.
2. Klicken Sie auf Neuer Schlüssel.
3. Geben Sie einen Name ein, damit Sie später wissen, wofür der Schlüssel verwendet wird.
4. Wählen Sie Zugriff auf alle Bots (auch Bots, die Sie später hinzufügen), oder deaktivieren Sie dies und wählen Sie bei Bots eine Auswahl aus.
5. Aktivieren Sie, was der Schlüssel zusätzlich darf: Darf Bots erstellen, Zugriff auf Leads und Inhalte verwalten. Standardmäßig ist alles deaktiviert.
6. Klicken Sie auf Erstellen.
7. Kopieren Sie den Schlüssel sofort und bewahren Sie ihn sicher auf. Danach können Sie ihn nicht mehr einsehen. Unter Ausprobieren finden Sie einen ersten Aufruf zum Testen.

Schlüssel verwalten

In der Liste sehen Sie pro Schlüssel den Zugriff, wann er Zuletzt verwendet wurde und wer ihn erstellt hat. Mit Bearbeiten passen Sie den Namen, die Bots und die Rechte an. Mit Widerrufen deaktivieren Sie einen Schlüssel sofort. Anwendungen, die ihn verwenden, haben dann keinen Zugriff mehr, und die damit erstellten Webhooks werden entfernt. Dies kann nicht rückgängig gemacht werden.

Wichtig zu wissen

• Nur der Administrator des Kontos (Rolle Administrator) erstellt und verwaltet API-Schlüssel. Siehe Team.
• Geben Sie einem Schlüssel nur die Rechte, die er benötigt. Mit Zugriff auf Leads kann Software Kontaktdaten von Besuchern lesen.
• Ist ein Schlüssel geleakt? Widerrufen Sie ihn und erstellen Sie einen neuen.
• Möchten Sie Leads sofort weiterleiten, ohne sie selbst abzurufen? Verwenden Sie Webhooks.
• Möchten Sie Ihre Bots in ChatGPT oder Claude nutzen? Dann benötigen Sie keinen Schlüssel. Siehe MCP.