API-Schlüssel
Erstellen, anzeigen und widerrufen Sie die beiden Schlüsselarten, die Syncanix ausstellt — einen geheimen Schlüssel für CLI und MCP und einen veröffentlichbaren Schlüssel für das eingebettete Widget.
API-Schlüssel ermöglichen Ihren eigenen Tools den Zugriff auf Ihren Arbeitsbereich. Es gibt zwei Arten, und der Unterschied ist wichtig: Die eine ist ein serverseitiges Geheimnis, die andere kann gefahrlos in Ihrer Webseite ausgeliefert werden.
Die zwei Schlüsselarten
- Geheimer Schlüssel (gak_…)
- Voller Funktionsumfang und nur serverseitig. Die CLI nutzt ihn zum Hochladen Ihres Katalogs, der MCP-Server zur Authentifizierung. Halten Sie ihn aus jeglichem clientseitigen Code heraus.
- Veröffentlichbarer Schlüssel (pk_…)
- Nur für Konversationen und an die Herkunft gebunden, daher gefahrlos im Quelltext Ihrer Seite einbettbar — genau das, was das Chat-Widget verwendet. Sie kann einen Chat starten, mehr nicht.
gak_<env>_<32 base32 chars> # secret — CLI / MCP, server-side only
pk_<test|live>_<32 base32 chars> # publishable — embedded in your pageEinen Schlüssel erstellen
Schlüssel werden im Dashboard unter Einstellungen → API-Schlüssel verwaltet.
- Öffnen Sie API-SchlüsselGehen Sie zu Einstellungen → API-Schlüssel und wählen Sie die Umgebung, für die Sie einen Schlüssel erstellen.
- Wählen Sie die ArtErstellen Sie einen geheimen Schlüssel für CLI oder MCP oder einen veröffentlichbaren Schlüssel für das Widget. Geben Sie ihm einen Namen, den Sie später wiedererkennen.
- Kopieren Sie ihn jetztDer vollständige Schlüssel wird genau einmal angezeigt. Kopieren Sie ihn und bewahren Sie ihn sicher auf, bevor Sie den Dialog schließen.
Schlüssel gelten pro Umgebung
Jeder Schlüssel gehört zu einer Umgebung. Ein Entwicklungsschlüssel kann keine Produktionsdaten berühren und umgekehrt, wodurch Ihr Test- und Live-Verkehr sauber getrennt bleibt.
Einen Schlüssel widerrufen
Widerrufen Sie einen Schlüssel auf derselben Seite, und er funktioniert sofort nicht mehr. Widerrufen Sie ihn sofort, falls er je offengelegt wird, und erstellen Sie dann einen Ersatz. Das Widerrufen eines Schlüssels betrifft nie einen anderen.
Schlüssel sicher aufbewahren
- Bewahren Sie geheime Schlüssel in einem Secrets-Manager oder einer Umgebungsvariable auf — nie in der Versionsverwaltung oder im Frontend-Code.
- Veröffentlichbare Schlüssel sind für das Frontend gedacht — sie starten nur Konversationen und sind an die von Ihnen erlaubten Ursprünge gebunden.
- Rotieren Sie Schlüssel regelmäßig: Erstellen Sie den neuen, stellen Sie Ihre Tools darauf um und widerrufen Sie dann den alten.
- Erstellung und Widerruf jedes Schlüssels werden im Audit-Protokoll Ihres Arbeitsbereichs festgehalten.