Les clés d’API sont générées à partir de la page Admin / API. Accédez à Admin-Avancé-Clés d’API :
Après avoir cliqué sur le bouton « Ajouter une clé d’API », vous serez dirigé vers une page pour configurer la clé :
Chaque clé d’API nécessite une description, un niveau d’utilisateur et une portée.
Description
La description peut être tout ce que vous choisissez.
Niveau d’utilisateur
Le menu déroulant Niveau d’utilisateur vous permet de choisir entre « Tous les utilisateurs » ou « Utilisateur unique ». Si « Tous les utilisateurs » est sélectionné, la clé peut être utilisée au nom de n’importe quel utilisateur. Ceci est réalisé en définissant l’utilisateur pour lequel vous effectuez la requête comme étant Api-Username dans les en-têtes de la requête. (Voir l’exemple d’authentification dans la documentation de l’API pour plus de détails sur la façon de définir les en-têtes de requête.)
Si « Utilisateur unique » est sélectionné, un champ utilisateur apparaîtra sur le formulaire. Entrez le nom d’utilisateur de l’utilisateur pour lequel vous générez la clé d’API dans ce champ :
Portée
Le menu déroulant Portée vous permet de sélectionner soit « Globale », « Lecture seule » ou « Granulaire » comme portée.
Si « Globale » est sélectionnée comme portée, la clé peut être utilisée pour toutes les requêtes que l’utilisateur pour lequel la clé a été générée, ou le nom d’utilisateur entré comme Api-Username de la requête, a la permission d’effectuer.
Si « Lecture seule » est sélectionnée comme portée, la clé d’API ne pourra être utilisée que pour effectuer des requêtes GET. La clé pourra effectuer toutes les requêtes GET que l’utilisateur pour lequel la clé a été générée, ou le nom d’utilisateur entré comme Api-Username de la requête, a la permission d’effectuer.
Si « Granulaire » est sélectionnée comme portée, un formulaire vous permettant de choisir parmi les portées disponibles sera ouvert. Passez votre souris sur l’icône point d’interrogation d’une portée pour voir une description de cette portée. Cliquez sur l’icône de lien de la portée pour voir une liste des chemins et des méthodes de requête que cette portée prend en charge. Notez que de nombreuses portées vous permettent d’entrer un paramètre supplémentaire pour limiter les chemins sur le site auxquels la portée permettra l’accès :
Après avoir configuré la clé d’API et cliqué sur le bouton Enregistrer, la clé d’API complète vous sera affichée une seule fois. Assurez-vous de copier la clé car il n’y a aucun moyen de revoir la clé complète.
Les portées d’API dans Discourse peuvent seulement restreindre les actions qu’une clé d’API peut effectuer par rapport aux permissions existantes de l’utilisateur. Elles ne peuvent pas accorder des permissions supplémentaires au-delà de ce que l’utilisateur associé possède déjà.
revoke_api_keys_unused_days.
Lecture supplémentaire
Détails sur les limites de débit que Discourse applique aux clés d’API : Limites de débit globales et limitation dans Discourse.
Documentation de l’API Discourse : https://docs.discourse.org/.
Un guide utile pour déterminer comment structurer les requêtes API : Comment effectuer une rétro-ingénierie de l’API Discourse.
.
