Documentación de la API REST de Discourse

[Discourse]

API de Discourse

Consulte el sitio de documentación de la API de Discourse para obtener información detallada:

https://docs.discourse.org

Autenticación

Las solicitudes a la API deben utilizar autenticación basada en encabezados HTTP. Pase su Api-Key y Api-Username como encabezados HTTP. La autenticación a través de parámetros de consulta o cuerpo de la solicitud no es compatible (esto se eliminó en abril de 2020). Consulte el ejemplo de solicitud cURL a continuación.

Los únicos endpoints de la API que siguen siendo compatibles con credenciales en parámetros de consulta son las solicitudes a feeds RSS, el endpoint del Receptor de Correo y las rutas ICS.

El Content-Type se puede configurar como “application/x-www-form-urlencoded”, “multipart/form-data” o “application/json”.

Aquí hay un ejemplo de solicitud POST a través de 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"

---

Aquí hay un ejemplo de cómo se ve el sitio de documentación de la API:

Consumiendo la API

Puede consumir la API utilizando comandos cURL, pero recomendamos usar la gema discourse_api para que pueda usar 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…

Ingeniería inversa de endpoints de la API

No todos los endpoints están documentados, pero puede ver un ejemplo de solicitud y respuesta de la API para cualquier endpoint siguiendo esta guía:

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 …

Límites de velocidad globales y limitación (throttling) en Discourse

Discourse incluye 3 límites de velocidad globales diferentes que los administradores del sitio pueden configurar. Para obtener más detalles sobre estos límites, consulte:

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…

Creación de notificaciones a través de la 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.

Especificación de claves API de usuario

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…

---

Revisado por última vez por @sam el 2026-03-17T17:00:00Z