Einführung

Die Ferndesk-API ermöglicht es Ihnen, Dokumentations-Workflows zu automatisieren und Help-Center-Daten aus Ihren eigenen Tools zu lesen. Beginnen Sie hier, um einen API-Schlüssel zu erstellen, Ihre erste Anfrage zu stellen und die richtigen Endpunkte in der Referenz zu finden.

Einen API-Schlüssel erstellen

Öffnen Sie Ihre Kontoeinstellungen und gehen Sie zu Entwickler-Einstellungen. Erstellen Sie einen neuen API-Schlüssel, kopieren Sie ihn, sobald er erscheint, und speichern Sie ihn in einem sicheren Secrets Manager. Ferndesk zeigt den vollständigen Schlüssel nur bei der ersten Erstellung an.

Wenn Sie schrittweise Anleitungen für die Benutzeroberfläche benötigen, lesen Sie API-Schlüssel verwalten.

Anfragen authentifizieren

Senden Sie Ihren API-Schlüssel als Bearer-Token im Authorization-Header.

curl -H "Authorization: Bearer fdsk_your_api_key" \
  https://api.ferndesk.com/articles

Ersetzen Sie den Beispielschlüssel durch Ihren eigenen Schlüssel. Halten Sie API-Schlüssel geheim und widerrufen Sie alle Schlüssel, die offengelegt wurden oder nicht mehr benötigt werden.

Stellen Sie Ihre erste Anfrage

Ein einfacher erster Schritt besteht darin, Artikel oder Abschnitte aufzulisten, um zu bestätigen, dass Ihre Authentifizierung funktioniert.

Nutzen Sie die API-Referenz, um Anfrageformate, Parameter und Antwortbeispiele für jeden Endpunkt zu finden.

Was Sie mit der API tun können

• Help-Center-Inhalte wie Artikel und Abschnitte lesen

• Aufgaben für die Dokumentationsarbeit erstellen und verwalten

• Programmatisch mit Inhalten aus Ihren eigenen Systemen arbeiten

Was Sie als Nächstes lesen sollten

Öffnen Sie die API-Referenz für Details zu Endpunkten und Beispiele. Wenn Sie zuerst Anmeldedaten einrichten, lesen Sie API-Schlüssel verwalten.