API-Schlüssel verwalten
API-Schlüssel authentifizieren Anfragen an die Ferndesk API. Wenn Sie einen Schlüssel erstellen, wählen Sie eine Zugriffsvorgabe oder benutzerdefinierte Bereiche aus, damit der Schlüssel nur die Berechtigungen erhält, die er benötigt.
Behandeln Sie jeden Schlüssel als Geheimnis. Prüfen Sie Schlüssel niemals in die Versionsverwaltung ein. Widerrufen Sie einen Schlüssel sofort, wenn er offengelegt wird.
Einen API-Schlüssel erstellen
Klicken Sie in der linken Seitenleiste unter Entwicklern auf API.
Klicken Sie auf Neuer API-Schlüssel.
Geben Sie einen Schlüsselnamen ein (zum Beispiel Production oder CI/CD-Pipeline).
Wählen Sie unter Berechtigungen eine Vorgabe aus:
Voller Zugriff - Inhalte lesen, schreiben und veröffentlichen sowie Analysen, KI-Unterhaltungen und Webhooks.
Nur lesen - Inhalte, Analysen und KI-Unterhaltungen lesen. Kann nichts ändern.
Benutzerdefiniert - Wählen Sie einzelne Bereiche mit den unten aufgeführten Kontrollkästchen aus.
Klicken Sie auf Schlüssel erstellen.
Kopieren Sie auf API-Schlüssel speichern den Wert unter Ihr neuer API-Schlüssel und klicken Sie dann auf Fertig.
Dieser Schlüssel wird nicht noch einmal angezeigt. Kopieren Sie ihn an einen sicheren Ort, bevor Sie das Dialogfeld schließen.
Benutzerdefinierte Bereiche
Wenn Sie Benutzerdefiniert wählen, wählen Sie eine oder mehrere dieser Berechtigungen aus:
Berechtigung | Was sie erlaubt |
|---|---|
Inhalte lesen | Artikel, Sammlungen, Revisionen, Übersetzungen |
Inhalte schreiben | Entwürfe erstellen und bearbeiten, Sammlungen, Artikel verschieben, Papierkorb |
Veröffentlichen | Entwürfe live schalten, Veröffentlichung aufheben, Revisionen wiederherstellen |
Analysen lesen | Berichte und Artikel-Feedback |
KI-Unterhaltungen lesen | Unterhaltungsprotokolle von Endbenutzern |
Webhooks verwalten | Webhook-Endpunkte registrieren und verwalten |
Wenn Sie Inhalte schreiben oder Veröffentlichen auswählen, ist Inhalte lesen immer enthalten. Das Kontrollkästchen für Lesen bleibt aktiviert und zeigt Erforderlich für Inhalte schreiben und Veröffentlichen an. Sie müssen mindestens eine Berechtigung auswählen, bevor Sie einen benutzerdefinierten Schlüssel erstellen können.
Ihre API-Schlüssel anzeigen
Alle Schlüssel werden auf der API-Seite mit Schlüsselnamen, Ersteller, Erstellungszeit, letzter Verwendungszeit und Bereichs-Badges angezeigt.
Bereichsgebundene Schlüssel zeigen kompakte Badges wie read, write, publish, analytics, conversations und webhooks.
Schlüssel, die erstellt wurden, bevor Berechtigungen verfügbar waren, zeigen Legacy · voller Zugriff. Diese Schlüssel verhalten sich wie voller Zugriff und verwenden das alte API-Antwortformat. Rotieren Sie sie, um Berechtigungen zu übernehmen.
Der vollständige Schlüsselsecret wird nach der Erstellung nie wieder angezeigt.
Einen API-Schlüssel widerrufen
Rufen Sie die API-Seite auf.
Öffnen Sie das Menü neben dem Schlüssel und wählen Sie Widerrufen aus.
Bestätigen Sie im Dialogfeld API-Schlüssel widerrufen.
Das Widerrufen eines Schlüssels blockiert sofort jede Anfrage, die ihn verwendet.
Rotieren Sie Schlüssel regelmäßig und widerrufen Sie nicht verwendete. Bevorzugen Sie Nur lesen oder einen minimalen Benutzerdefiniert-Satz, wenn ein Workflow keinen Schreib- oder Veröffentlichungszugriff benötigt.
Wie Sie einen Schlüssel in API-Anfragen senden, finden Sie unter Authentifizierung.