Introduction
L’API Ferndesk vous permet d’automatiser les flux de travail liés à la documentation et de lire 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 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 sur l’interface utilisateur, 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é qui a été exposée ou dont vous n’avez plus besoin.
Effectuer votre première requête
Pour commencer simplement, listez les articles ou les sections afin de vérifier que votre authentification fonctionne.
Consultez la référence de l’API pour trouver les formats de requête, les paramètres et des exemples de réponses pour chaque point de terminaison.
Ce que vous pouvez faire avec l’API
Lire le contenu du centre d’aide, comme 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
À 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.