Documentation de l'API REST Discourse

[Discourse]

API Discourse

Veuillez consulter le site de la documentation de l’API Discourse pour obtenir des informations détaillées :

https://docs.discourse.org

Authentification

Les requêtes API doivent utiliser l’authentification par en-tête HTTP. Transmettez votre Api-Key et votre Api-Username en tant qu’en-têtes HTTP. L’authentification via les paramètres de requête ou le corps de la requête n’est pas prise en charge (cela a été supprimé en avril 2020). Veuillez consulter l’exemple de requête cURL ci-dessous.

Les seuls points de terminaison d’API qui continuent de prendre en charge les informations d’identification dans les paramètres de requête sont les requêtes aux flux RSS, au point de terminaison du récepteur de courrier et aux itinéraires ICS.

Le Content-Type peut être défini sur “application/x-www-form-urlencoded”, “multipart/form-data” ou “application/json”.

Voici un exemple de requête POST via cURL :

curl -X POST "http://127.0.0.1:3000/categories" \
-H "Content-Type: multipart/form-data;" \
-H "Api-Key: 714552c6148e1617aeab526d0606184b94a80ec048fc09894ff1a72b740c5f19" \
-H "Api-Username: discourse1" \
-F "name=89853c20-4409-e91a-a8ea-f6cdff96aaaa" \
-F "color=49d9e9" \
-F "text_color=f0fcfd"

---

Voici un exemple de ce à quoi ressemble le site de documentation de l’API :

Utilisation de l’API

Vous pouvez utiliser l’API à l’aide de commandes cURL, mais nous vous recommandons d’utiliser la gemme discourse_api afin de pouvoir utiliser Ruby.

Use the Discourse API ruby gem

So you want to use Discourse API? Great! Let’s get started. Set up Discourse development environment Set up Discourse development environment using our Windows, macOS or Ubuntu guide. Clone Discourse API Gem Now that you have set up Discourse development environment, you should already have Git and Ruby installed on your system. You can install Discourse API gem by running following command from console: git clone https://github.com/discourse/discourse_api.git ~/discourse_api Alternatively…

Ingénierie inverse des points de terminaison de l’API

Tous les points de terminaison ne sont pas documentés, mais vous pouvez voir un exemple de requête et de réponse de l’API pour n’importe quel point de terminaison en suivant ce guide :

Reverse engineer the Discourse API

Discourse is backed by a complete JSON api. Anything you can do on the site you can also do using the JSON api. The API is documented at docs.discourse.org. You can also use the discourse_api Ruby gem as a client library. However, not every endpoint is documented. To determine how to do something with the JSON API here are some steps you can follow. Example: recategorize a topic. Go to a topic and start editing a category: [image] Open Chrome dev tools, switch to the Network tab, select …

Limites de débit globales et limitation dans Discourse

Discourse est livré avec 3 limites de débit globales différentes qui peuvent être configurées par les administrateurs de site. Pour plus de détails sur ces limites, consultez :

Available settings for global rate limits and throttling

Discourse ships with 3 different global rate limits that can be configured by site admins. Global per-ip rate limits These limits apply to every unique IP address that hits the Discourse application. (files that are served directly from the filesystem or the CDN are excluded) By default this rate limit is enabled, you may disable it or set it to a reporting mode. DISCOURSE_MAX_REQS_PER_IP_MODE : default block, this rate limit applies out of the box. (other options are warn, warn+block, and no…

Création de notifications via l’API

Creating notifications via the API

Hi, a quick question: Can you send notifications to users with the API? (or another way). In the documentation, I found how to GET notifications of the user, how to mark them as read, but not how to POST some. If it isn’t possible, I guess there is always to possibility of using private messages instead. I would appreciate any input on this. Thanks.

Spécification des clés API utilisateur

User API keys specification

Discourse contains a system for generating API keys per user if a very specific protocol is followed. This feature facilitates “application” access to Discourse instances without needing to involve moderators. High level description At a high level: Client (desktop app, browser plugin, mobile app) generates a private/public key pair and return url Client redirects to a route on discourse giving discourse its public key Discourse gets approval from user to use app Discourse generat…

---

Dernière révision par @sam le 2026-03-17T17:00:00Z