Introduction à l’API
L’API Ferndesk vous permet d’automatiser les workflows de documentation et de consulter les données du centre d’aide depuis vos propres outils. Commencez ici pour créer une clé API, effectuer votre première requête et trouver les bons points de terminaison dans la référence.
Vous avez besoin d’une clé API avant de pouvoir envoyer des requêtes. Créez et gérez vos clés depuis Paramètres → Développeurs → API.
Créer une clé API
Ouvrez Paramètres, sélectionnez Développeurs, puis sélectionnez API. Créez une nouvelle clé API, copiez-la lorsqu’elle s’affiche et stockez-la dans un gestionnaire de secrets sécurisé. Ferndesk n’affiche la clé complète qu’au moment de sa création.
Si vous avez besoin d’instructions détaillées pour l’interface, consultez Gérer les clés API.
Authentifier les requêtes
Envoyez votre clé API en tant que jeton Bearer dans l’en-tête Authorization.
curl -H "Authorization: Bearer fdsk_your_api_key" \
https://api.ferndesk.com/v1/articlesRemplacez la clé d’exemple par votre propre clé. Gardez vos clés API secrètes et révoquez toute clé exposée ou dont vous n’avez plus besoin.
Effectuer votre première requête
Pour commencer simplement, vous pouvez lister des articles ou des sections afin de vérifier que votre authentification fonctionne.
Utilisez la référence de l’API pour trouver les formats de requête, les paramètres et les exemples de réponses pour chaque point de terminaison.
Ce que vous pouvez faire avec l’API
Consulter le contenu du centre d’aide, notamment les articles et les sections
Créer et gérer des tâches liées au travail de documentation
Travailler avec du contenu par programmation depuis vos propres systèmes
Formats du contenu des articles
Consultez le contenu des articles sous forme de contentHtml (par défaut), de contentMarkdown ou de contentJson, en sélectionnant le format avec le paramètre de requête ?format= sur les points de terminaison des articles.
Les blocs de fichiers (fichiers téléchargeables hébergés dans un article) sont des nœuds de type file avec src, name, size, mimeType et un caption facultatif. Dans contentMarkdown, un bloc de fichier est rendu sous forme de lien vers le fichier, avec son type et sa taille entre parenthèses, et sa légende éventuelle dans un nouveau paragraphe entouré de traits de soulignement.
L’API ne téléverse jamais les octets des fichiers. Pour écrire un nœud File, fournissez un chemin hébergé existant de Ferndesk comme src. Les images sont différentes : l’API téléverse automatiquement leurs sources. Consultez Téléversements d’images.
À lire ensuite
Ouvrez la référence de l’API pour consulter les détails et les exemples des points de terminaison. Si vous configurez d’abord vos identifiants, consultez Gérer les clés API.