API-Schlüsselverwaltung
API-Schlüssel ermöglichen programmatischen Zugriff auf die itellicoAI-Plattform, sodass du Agenten in deine Anwendungen integrieren, Aufgaben automatisieren und benutzerdefinierte Workflows erstellen kannst. Sie ergänzen Integrationen, um die Möglichkeiten deiner Agenten zu erweitern.Was sind API-Schlüssel?
API-Schlüssel sind sichere Token, die deine API-Anfragen authentifizieren, ohne dass Nutzer-Zugangsdaten erforderlich sind. Wesentliche Eigenschaften:- Account-gebunden — Jeder Schlüssel gehört zu einem bestimmten Account
- Berechtigungsbewusst — Anfragen verwenden weiterhin die Account- und Rollenberechtigungen des Schlüsselerstellers
- Geheim — Behandle ihn wie ein Passwort; niemals weitergeben oder in die Versionsverwaltung einchecken
- Widerrufbar — Kann jederzeit deaktiviert oder gelöscht werden
- Nachverfolgbar — Letzten Verwendungszeitstempel und Aktivität überwachen
API-Schlüssel erstellen
Ein Label eingeben
Gib deinem Schlüssel einen aussagekräftigen Namen, z. B.:
- „Produktionsserver”
- „Entwicklungsumgebung”
- „Automatisierungssystem”
- „Mobile App – iOS”
Ablaufdatum festlegen (optional)
Lege optional ein Ablaufdatum für die automatische Schlüsselrotation fest
API-Schlüssel verwenden
Authentifizierungs-Header
Füge deinen API-Schlüssel imX-API-Key-Header ein:
Account-Kontext
API-Schlüssel sind auf ihren Account beschränkt. In einem übergeordneten Account erstellte Schlüssel können sowohl auf den übergeordneten Account als auch auf alle Subaccounts zugreifen.SDKs
Mit den offiziellen SDKs:API-Schlüssel verwalten
Schlüssel anzeigen
Die API-Schlüssel-Seite zeigt:| Spalte | Beschreibung |
|---|---|
| Label | Dein beschreibender Name |
| Teilschlüssel | Die ersten Zeichen zur Identifikation |
| Status | Aktiv, Widerrufen oder Abgelaufen |
| Erstellt | Erstellungsdatum des Schlüssels |
| Zuletzt verwendet | Wann er zuletzt für eine API-Anfrage verwendet wurde |
| Läuft ab | Ablaufdatum (sofern festgelegt) |
Der vollständige Schlüssel wird nach der Erstellung niemals angezeigt – nur die ersten Zeichen zur Identifikation.
Schlüssel bearbeiten
Du kannst folgendes aktualisieren:- Label — Den beschreibenden Namen ändern
- Ablaufdatum — Ablauf verlängern oder festlegen
Schlüssel widerrufen
Um einen Schlüssel vorübergehend zu deaktivieren, ohne ihn zu löschen:- Gehe zu Account → API-Schlüssel
- Suche den Schlüssel in der Liste
- Klicke auf Widerrufen
- Der Schlüssel wird sofort deaktiviert
Schlüssel löschen
Um einen Schlüssel dauerhaft zu entfernen:- Gehe zu Account → API-Schlüssel
- Suche den Schlüssel und klicke auf das Menü-Symbol
- Wähle Löschen
- Bestätige das Löschen
Schlüsselstatus
| Status | Beschreibung | API-Zugriff |
|---|---|---|
| Aktiv | Schlüssel funktioniert normal | Ja |
| Widerrufen | Manuell deaktiviert | Nein |
| Abgelaufen | Ablaufdatum überschritten | Nein |
Sicherheits-Best-Practices
Schlüssel niemals in die Versionsverwaltung einchecken
Schlüssel niemals in die Versionsverwaltung einchecken
Wenn du versehentlich einen Schlüssel eingecheckt hast:
- Den Schlüssel sofort widerrufen
- Einen neuen Schlüssel erstellen
- Das Entwicklungsteam bitten, den Schlüssel aus dem Versionsverwaltungsverlauf zu entfernen
- Den neuen Schlüssel in deinen Anwendungen deployen
Umgebungsvariablen verwenden
Umgebungsvariablen verwenden
Schreibe API-Schlüssel niemals fest in den Quellcode.Füge
.env-Dateien zu deiner .gitignore hinzu:Ein Schlüssel pro Umgebung
Ein Schlüssel pro Umgebung
Erstelle separate Schlüssel für Entwicklung, Staging und Produktion. So kannst du einen kompromittierten Schlüssel widerrufen, ohne andere Umgebungen zu beeinflussen.
Schlüssel regelmäßig rotieren
Schlüssel regelmäßig rotieren
Empfohlener Rotationsplan:
- Produktion: alle 90 Tage
- Staging: alle 180 Tage
- Entwicklung: jährlich oder bei Teamwechseln
- Neuen Schlüssel erstellen
- Anwendung mit dem neuen Schlüssel aktualisieren
- Gründlich testen
- Alten Schlüssel widerrufen
- Alten Schlüssel nach 30 Tagen löschen
Secrets Manager verwenden
Secrets Manager verwenden
Speichere Schlüssel in der Produktion in einem Secrets Manager:
- AWS Secrets Manager
- HashiCorp Vault
- Azure Key Vault
- Google Secret Manager
- 1Password oder ähnliche Team-Lösungen
Nutzung überwachen
Nutzung überwachen
Überprüfe regelmäßig die Zeitstempel unter „Zuletzt verwendet”. Lösche Schlüssel, die mehr als 90 Tage nicht verwendet wurden.
Bei einem kompromittierten Schlüssel
Ersatzschlüssel erstellen
Generiere einen neuen Schlüssel im selben Account mit einem aussagekräftigen Label
Protokolle prüfen
Überprüfe die Nutzungsprotokolle auf verdächtige Aktivitäten während des Expositionszeitraums
Fehlerbehebung
401 Nicht autorisiert
401 Nicht autorisiert
Ursachen: Ungültiger Schlüssel, widerrufener oder abgelaufener Schlüssel, fehlender oder fehlerhaft formatierter
X-API-Key-Header.Lösungen: Verifiziere, dass der Schlüssel in den Einstellungen aktiv ist. Überprüfe das Header-Format: X-API-Key: sk-.... Stelle sicher, dass keine zusätzlichen Leerzeichen oder Zeichen vorhanden sind.403 Verboten
403 Verboten
Ursachen: Der Schlüsselersteller verfügt nicht über die erforderliche Account-Berechtigung, oder der Schlüssel kann nicht auf den angeforderten Account zugreifen.Lösungen: Überprüfe die Account-ID in der URL. Stelle sicher, dass der Schlüssel im richtigen Account erstellt wurde und der Ersteller noch über die erforderliche Rolle für die Operation verfügt.
429 Zu viele Anfragen
429 Zu viele Anfragen
Ursachen: Rate-Limit überschritten.Lösungen: Implementiere exponentielles Backoff. Antworte nach Möglichkeit aus dem Cache. Verteile Anfragen über die Zeit.
Häufige Fragen
Wie viele API-Schlüssel kann ich erstellen?
Wie viele API-Schlüssel kann ich erstellen?
Es gibt keine feste Obergrenze. Empfohlen wird eine überschaubare Anzahl – typischerweise 3–5 Schlüssel für kleine Teams, 10–15 für mittlere Teams.
Kann ich einen Schlüssel für mehrere Accounts verwenden?
Kann ich einen Schlüssel für mehrere Accounts verwenden?
In einem übergeordneten Account erstellte Schlüssel können auf den übergeordneten Account und alle Subaccounts zugreifen. In einem Subaccount erstellte Schlüssel können nur auf diesen Subaccount zugreifen.
Können Subaccounts eigene API-Schlüssel haben?
Können Subaccounts eigene API-Schlüssel haben?
Ja. Jeder Subaccount kann unabhängige API-Schlüssel erstellen, die auf diesen Subaccount beschränkt sind.
Laufen API-Schlüssel automatisch ab?
Laufen API-Schlüssel automatisch ab?
Nur wenn du bei der Erstellung ein Ablaufdatum festgelegt hast. Andernfalls bleiben Schlüssel aktiv, bis sie widerrufen oder gelöscht werden.
Nächste Schritte
API-Referenz
Verfügbare API-Endpunkte erkunden
SDKs
Die offiziellen Python- und TypeScript-SDKs verwenden
Integrationen
Drittanbieter-Dienste und Webhooks verbinden