Le chiavi API vengono generate dalla pagina Admin / API. Vai su Admin-Avanzate-Chiavi API:
Dopo aver fatto clic sul pulsante “Aggiungi chiave API”, verrai indirizzato a una pagina per configurare la chiave:
Ogni chiave API necessita di una descrizione, un livello utente e uno scopo (scope).
Descrizione
La descrizione può essere qualsiasi cosa tu scelga.
Livello Utente
Il menu a discesa Livello Utente ti consente di selezionare “Tutti gli utenti” o “Utente singolo”. Se è selezionato “Tutti gli utenti”, la chiave può essere utilizzata per conto di qualsiasi utente. Ciò avviene impostando l’utente per conto del quale si sta effettuando la richiesta come Api-Username nelle intestazioni della richiesta. (Vedere l’esempio di autenticazione nella documentazione API per i dettagli su come impostare le intestazioni della richiesta.)
Se è selezionato “Utente singolo”, apparirà un campo utente nel modulo. Inserisci il nome utente dell’utente per il quale stai generando la chiave API in quel campo:
Scopo
Il menu a discesa Scopo ti consente di selezionare “Globale”, “Sola lettura” o “Granulare” come scopo.
Se “Globale” è selezionato come scopo, la chiave può essere utilizzata per qualsiasi richiesta che l’utente per cui è stata generata la chiave, o il nome utente inserito come Api-Username della richiesta, ha il permesso di eseguire.
Se “Sola lettura” è selezionato come scopo, la chiave API potrà essere utilizzata solo per effettuare richieste GET. La chiave potrà effettuare qualsiasi richiesta GET che l’utente per cui è stata generata la chiave, o il nome utente inserito come Api-Username della richiesta, ha il permesso di eseguire.
Se “Granulare” è selezionato come scopo, si aprirà un modulo che ti permetterà di selezionare tra gli scopi disponibili. Passa con il mouse sull’icona del punto interrogativo di uno scopo per vedere una descrizione dello scopo. Fai clic sull’icona del collegamento dello scopo per vedere un elenco di percorsi e metodi di richiesta supportati dallo scopo. Nota che molti degli scopi ti consentono di inserire un parametro aggiuntivo per limitare i percorsi sul sito a cui lo scopo consentirà l’accesso:
Dopo aver configurato la chiave API e aver fatto clic sul pulsante Salva, la chiave API completa ti verrà mostrata una sola volta. Assicurati di copiare la chiave poiché non c’è modo di visualizzare nuovamente la chiave completa.
Gli scopi API in Discourse possono solo limitare quali azioni una chiave API può eseguire rispetto alle autorizzazioni esistenti dell’utente. Non possono concedere autorizzazioni aggiuntive oltre a quelle che l’utente associato possiede già.
revoke_api_keys_unused_days.
Letture aggiuntive
Dettagli sui limiti di frequenza che Discourse applica alle chiavi API: Limiti di frequenza globali e throttling in Discourse.
Documentazione API di Discourse: https://docs.discourse.org/.
Una guida utile per capire come strutturare le richieste API: Come fare reverse engineering dell’API di Discourse.
.
