API-Einführung
Mit der Ferndesk API können Sie Dokumentations-Workflows automatisieren und Help-Center-Daten aus Ihren eigenen Tools lesen. Beginnen Sie hier, um einen API-Schlüssel zu erstellen, Ihre erste Anfrage zu senden und in der Referenz die richtigen Endpunkte zu finden.
Sie benötigen einen API-Schlüssel, bevor Sie Anfragen senden können. Erstellen und verwalten Sie Schlüssel unter Einstellungen → Entwickler → API.
API-Schlüssel erstellen
Öffnen Sie die Einstellungen, wählen Sie Entwickler und anschließend API. 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 schrittweise 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/articlesErsetzen 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 besteht darin, Artikel oder Bereiche aufzulisten, damit Sie überprüfen können, ob 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
Help-Center-Inhalte wie Artikel und Bereiche lesen
Aufgaben für Dokumentationsarbeiten erstellen und verwalten
Programmgesteuert mit Inhalten aus Ihren eigenen Systemen arbeiten
Artikelinhaltsformate
Lesen Sie Artikelinhalte als contentHtml (Standard), contentMarkdown oder contentJson, ausgewählt mit dem Abfrageparameter ?format= bei den Artikel-Endpunkten.
Dateiblöcke (herunterladbare Dateien, die in einem Artikel gehostet werden) sind Knoten vom Typ file mit src, name, size, mimeType und einer optionalen caption. In contentMarkdown wird ein Dateiblock als Link zur Datei mit ihrem Typ und ihrer Größe in Klammern dargestellt; die Bildunterschrift wird, falls vorhanden, in einem neuen Absatz und von Unterstrichen eingeschlossen dargestellt.
Die API lädt niemals Dateibytes hoch. Um einen Dateiknoten zu schreiben, geben Sie unter src einen vorhandenen von Ferndesk gehosteten Pfad an. Bei Bildern ist das anders: Die API lädt Bildquellen automatisch hoch. Siehe Bild-Uploads.
Was Sie als Nächstes lesen sollten
Öffnen Sie die API-Referenz, um Details und Beispiele zu den Endpunkten zu finden. Wenn Sie zuerst Anmeldedaten einrichten, lesen Sie API-Schlüssel verwalten.