API-Einführung

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

API-Schlüssel erstellen

Öffnen Sie die Einstellungen, wählen Sie Entwickler und anschließend API aus. Erstellen Sie einen neuen API-Schlüssel, kopieren Sie ihn, sobald er angezeigt wird, und speichern Sie ihn in einem sicheren Secrets-Manager. Ferndesk zeigt den vollständigen Schlüssel nur bei der erstmaligen Erstellung an.

Wenn Sie eine Schritt-für-Schritt-Anleitung 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/v1/articles

Ersetzen Sie den Beispielschlüssel durch Ihren eigenen Schlüssel. Halten Sie API-Schlüssel geheim und widerrufen Sie jeden Schlüssel, der offengelegt wurde oder nicht mehr benötigt wird.

Ihre erste Anfrage senden

Ein einfacher erster Schritt ist das Auflisten von Artikeln oder Abschnitten, damit Sie bestätigen können, dass Ihre Authentifizierung funktioniert.

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

Was Sie mit der API tun können

• Hilfe-Center-Inhalte wie Artikel und Abschnitte lesen

• Aufgaben für Dokumentationsarbeiten erstellen und verwalten

• Inhalte programmgesteuert aus Ihren eigenen Systemen bearbeiten

Was Sie als Nächstes lesen sollten

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