Documentação da API REST do Discourse

[Discourse]

API do Discourse

Consulte o site da Documentação da API do Discourse para obter informações detalhadas:

https://docs.discourse.org

Autenticação

As solicitações de API devem usar autenticação baseada em cabeçalho HTTP. Passe sua Api-Key e Api-Username como cabeçalhos HTTP. A autenticação via parâmetros de consulta ou corpo da solicitação não é suportada (isso foi removido em abril de 2020). Consulte o exemplo de solicitação cURL abaixo.

Os únicos endpoints de API que continuam a suportar credenciais em parâmetros de consulta são as solicitações para feeds RSS, o endpoint de Receptor de E-mail e as rotas ICS.

O Content-Type pode ser definido como “application/x-www-form-urlencoded”, “multipart/form-data” ou “application/json”.

Aqui está um exemplo de solicitação 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"

---

Aqui está um exemplo de como é o site da Documentação da API:

Consumindo a API

Você pode consumir a API usando comandos cURL, mas recomendamos o uso da gem discourse_api para que você possa 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…

Engenharia Reversa dos Endpoints da API

Nem todo endpoint é documentado, mas você pode ver um exemplo de solicitação e resposta da API para qualquer endpoint seguindo este guia:

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 taxa globais e throttling no Discourse

O Discourse é fornecido com 3 limites de taxa globais diferentes que podem ser configurados pelos administradores do site. Para mais detalhes sobre esses limites, 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…

Criando notificações via 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.

Especificação das chaves de API do usuário

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…

---

Última Revisão por @sam em 2026-03-17T17:00:00Z