Discourse est soutenu par une API JSON complète. Tout ce que vous pouvez faire sur le site, vous pouvez également le faire via l’API JSON.
L’API est documentée sur docs.discourse.org. Vous pouvez également utiliser la gemme Ruby discourse_api comme bibliothèque cliente. Cependant, tous les points de terminaison ne sont pas documentés.
Pour déterminer comment effectuer une action avec l’API JSON, voici quelques étapes que vous pouvez suivre.
Exemple : recatégoriser un sujet.
- Allez sur un sujet et commencez à modifier une catégorie :
- Ouvrez les outils de développement de Chrome, passez à l’onglet Network (Réseau), sélectionnez le filtre Fetch/XHR :
- Effectuez l’opération
- Les données de la requête apparaîtront sous l’onglet “Payload” (Charge utile)
- Regardez également l’aperçu pour comprendre les résultats
- Vous avez maintenant toutes les informations nécessaires.
-
Le point de terminaison est
https://try.discourse.org/t/online-learning/108.json -
La charge utile est transmise en utilisant une requête
PUT -
Le paramètre envoyé est :
category_id: 5
Fort de ces informations, vous pouvez effectuer vos propres appels en utilisant votre langage de programmation préféré. Tout ce que vous avez à faire est d’ajouter votre Api-Username et votre Api-Key aux en-têtes de la requête. (Voir Discourse REST API Documentation pour les détails sur la façon de formuler une requête curl vers l’API Discourse.)
Les informations d’identification de l’API peuvent être générées depuis le panneau d’administration à l’adresse /admin/api/keys :
