Einführung

Die Ferndesk-API ermöglicht es Ihnen, Dokumentations-Workflows zu automatisieren und Hilfe-Center-Daten aus 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 Ihre Kontoeinstellungen und gehen Sie zu den Entwickler-Einstellungen. 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 direkt nach der Erstellung an.

Eine Schritt-für-Schritt-Anleitung für die Benutzeroberfläche finden Sie unter 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.

Ihre erste Anfrage senden

Ein einfacher erster Schritt ist das Auflisten von Artikeln oder Abschnitten, um zu bestätigen, dass Ihre Authentifizierung funktioniert.

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

Möglichkeiten mit der API

• Inhalte des Hilfe-Centers wie Artikel und Abschnitte lesen

• Aufgaben für die Dokumentationsarbeit erstellen und verwalten

• Inhalte programmatisch aus Ihren eigenen Systemen heraus bearbeiten

Was Sie als Nächstes lesen sollten

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