Présentation de l’API
L’API Ferndesk vous permet d’automatiser les workflows de documentation et de consulter les données de votre centre d’aide depuis vos propres outils. Commencez ici pour créer une clé API, effectuer votre première requête et trouver les endpoints appropriés 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 sécurisé de secrets. 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, consultez Gérer les clés API.
Authentifier les requêtes
Envoyez votre clé API sous forme de 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, répertoriez des articles ou des 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 endpoint.
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 le contenu de manière programmatique depuis vos propres systèmes
Que lire ensuite
Ouvrez la référence de l’API pour consulter les détails et les exemples des endpoints. Si vous configurez d’abord vos identifiants, consultez Gérer les clés API.