Introduction
L'API Ferndesk vous permet d'automatiser vos flux de travail de documentation et de lire les données du centre d'aide à partir de vos propres outils. Commencez ici pour créer une clé API, effectuer votre première requête et trouver les points de terminaison 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 les paramètres Développeur dans l'application Ferndesk.
Créer une clé API
Ouvrez les paramètres de votre compte et accédez aux Paramètres développeur. Créez une nouvelle clé API, copiez-la lorsqu'elle s'affiche et conservez-la dans un gestionnaire de secrets sécurisé. Ferndesk n'affiche la clé complète que lors de sa création initiale.
Si vous avez besoin d'instructions étape par étape concernant l'interface utilisateur, 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/articlesRemplacez la clé d'exemple par votre propre clé. Gardez les 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
Une première étape simple consiste à lister les articles ou les sections afin de confirmer 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éponse pour chaque point de terminaison.
Ce que vous pouvez faire avec l'API
Lire le contenu du centre d'aide tel que les articles et les sections
Créer et gérer des tâches pour le travail de documentation
Travailler avec le contenu par programmation depuis vos propres systèmes
Que lire ensuite
Ouvrez la référence de l'API pour obtenir les détails et les exemples des points de terminaison. Si vous configurez d'abord vos identifiants, consultez Gérer les clés API.