Le chiavi API vengono generate dalla pagina Admin / API. Vai su Admin-Advanced-API Keys:
Dopo aver fatto clic sul pulsante “New API Key”, verrai indirizzato a una pagina per configurare la chiave:
Ogni chiave API necessita di una descrizione, un livello utente e uno scope.
Descrizione
La descrizione può essere qualsiasi cosa tu scelga.
Livello Utente
Il menu a discesa User Level ti consente di selezionare “All Users” o “Single User”. Se viene selezionato “All Users”, la chiave può essere utilizzata per conto di qualsiasi utente. Ciò viene fatto impostando l’utente per conto del quale stai effettuando la richiesta come Api-Username nelle intestazioni della richiesta. (Vedi l’esempio di autenticazione nella documentazione API per i dettagli su come impostare le intestazioni della richiesta.)
Se viene selezionato “Single User”, apparirà un campo utente nel modulo. Inserisci il nome utente per cui stai generando la chiave API in quel campo:
Scope
Il menu a discesa Scope ti consente di selezionare “Granular”, “Read-only” o “Global” come scope.
Se viene selezionato “Read-only” come scope, la chiave API potrà essere utilizzata solo per effettuare richieste GET. La chiave sarà in grado di 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 viene selezionato “Global” come scope, 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 viene selezionato “Granular” come scope, verrà aperto un modulo che ti consentirà di selezionare tra gli scope disponibili. Passa il mouse sull’icona del punto interrogativo di uno scope per vedere una descrizione dello scope. Fai clic sull’icona del link dello scope per vedere un elenco di percorsi e metodi di richiesta supportati dallo scope. Nota che molti degli scope ti consentono di inserire un parametro aggiuntivo per limitare quali percorsi sul sito lo scope consentirà l’accesso:
Dopo aver configurato la chiave API e 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 scope API in Discourse possono solo limitare le azioni che una chiave API può eseguire rispetto alle autorizzazioni esistenti dell’utente. Non possono concedere autorizzazioni aggiuntive oltre a quelle che l’utente associato ha già.
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 effettuare il reverse engineering dell’API di Discourse.
.
