As chaves de API são geradas na página Admin / API. Vá para Admin-Avançado-Chaves de API:
Após clicar no botão “Nova Chave de API”, você será levado a uma página para configurar a chave:
Cada chave de API precisa de uma descrição, um nível de usuário e um escopo.
Descrição
A descrição pode ser qualquer coisa que você escolher.
Nível de Usuário
O menu suspenso Nível de Usuário permite que você selecione “Todos os Usuários” ou “Usuário Único”. Se “Todos os Usuários” for selecionado, a chave poderá ser usada em nome de qualquer usuário. Isso é feito definindo o usuário em nome de quem você está fazendo a solicitação como Api-Username nos cabeçalhos da solicitação. (Veja o exemplo de Autenticação na documentação da API para detalhes sobre como definir os cabeçalhos da solicitação.)
Se “Usuário Único” for selecionado, um campo de usuário aparecerá no formulário. Insira o nome de usuário para o qual você está gerando a chave de API nesse campo:
Escopo
O menu suspenso Escopo permite que você selecione “Granular”, “Somente Leitura” ou “Global” como escopo.
Se “Somente Leitura” for selecionado como escopo, a chave de API só poderá ser usada para fazer requisições GET. A chave poderá fazer quaisquer requisições GET que o usuário para o qual a chave foi gerada, ou o nome de usuário inserido como Api-Username da requisição, tenha permissão para executar.
Se “Global” for selecionado como escopo, a chave poderá ser usada para quaisquer requisições que o usuário para o qual a chave foi gerada, ou o nome de usuário inserido como Api-Username da requisição, tenha permissão para executar.
Se “Granular” for selecionado como escopo, um formulário que permite selecionar os escopos disponíveis será aberto. Passe o mouse sobre o ícone de ponto de interrogação de um escopo para ver uma descrição do escopo. Clique no ícone de link do escopo para ver uma lista de caminhos e métodos de requisição que o escopo suporta. Observe que muitos dos escopos permitem que você insira um parâmetro adicional para limitar quais caminhos no site o escopo permitirá acesso:
Após configurar a chave de API e clicar no botão Salvar, a chave de API completa será exibida uma única vez. Certifique-se de copiar a chave, pois não há como visualizar a chave completa novamente.
Os escopos de API no Discourse só podem restringir quais ações uma chave de API pode executar em relação às permissões existentes do usuário. Eles não podem conceder permissões adicionais além do que o usuário associado já possui.
Leitura adicional
Detalhes sobre os limites de taxa que o Discourse aplica às chaves de API: Limites de taxa globais e throttling no Discourse.
Documentação da API do Discourse: https://docs.discourse.org/.
Um guia útil para descobrir como estruturar requisições de API: Como fazer engenharia reversa da API do Discourse.
.
