API-Schlüssel werden auf der Seite Admin / API generiert. Gehen Sie zu Admin-Erweitert-API-Schlüssel:
Nach dem Klicken auf die Schaltfläche „Neuer API-Schlüssel“ werden Sie zu einer Seite weitergeleitet, auf der Sie den Schlüssel konfigurieren können:
Jeder API-Schlüssel benötigt eine Beschreibung, eine Benutzerebene und einen Geltungsbereich (Scope).
Beschreibung
Die Beschreibung kann beliebig gewählt werden.
Benutzerebene
Das Dropdown-Menü „Benutzerebene“ ermöglicht Ihnen die Auswahl zwischen „Alle Benutzer“ oder „Einzelner Benutzer“. Wenn „Alle Benutzer“ ausgewählt ist, kann der Schlüssel im Namen eines beliebigen Benutzers verwendet werden. Dies geschieht durch Festlegen des Benutzers, in dessen Namen Sie die Anfrage stellen, als Api-Username in den Anforderungsheadern. (Weitere Einzelheiten zum Festlegen der Anforderungsheader finden Sie im API-Dokumentation unter „Authentication example“.)
Wenn „Einzelner Benutzer“ ausgewählt ist, wird ein Benutzerfeld im Formular angezeigt. Geben Sie in dieses Feld den Benutzernamen des Benutzers ein, für den Sie den API-Schlüssel generieren:
Geltungsbereich (Scope)
Das Dropdown-Menü „Geltungsbereich“ ermöglicht Ihnen die Auswahl zwischen „Granular“, „Nur Lesezugriff“ (Read-only) oder „Global“ als Geltungsbereich.
Wenn „Nur Lesezugriff“ als Geltungsbereich ausgewählt ist, kann der API-Schlüssel nur für GET-Anfragen verwendet werden. Der Schlüssel kann alle GET-Anfragen ausführen, zu denen der Benutzer, für den der Schlüssel generiert wurde, oder der als Api-Username in der Anfrage eingegebene Benutzername berechtigt ist.
Wenn „Global“ als Geltungsbereich ausgewählt ist, kann der Schlüssel für alle Anfragen verwendet werden, zu denen der Benutzer, für den der Schlüssel generiert wurde, oder der als Api-Username in der Anfrage eingegebene Benutzername berechtigt ist.
Wenn „Granular“ als Geltungsbereich ausgewählt ist, wird ein Formular geöffnet, in dem Sie aus den verfügbaren Geltungsbereichen auswählen können. Fahren Sie mit der Maus über das Fragezeichensymbol eines Geltungsbereichs, um eine Beschreibung des Geltungsbereichs anzuzeigen. Klicken Sie auf das Link-Symbol des Geltungsbereichs, um eine Liste der Pfade und Anforderungsmethoden anzuzeigen, die der Geltungsbereich unterstützt. Beachten Sie, dass viele der Geltungsbereiche es Ihnen ermöglichen, einen zusätzlichen Parameter einzugeben, um die Pfade auf der Website, auf die der Geltungsbereich Zugriff gewährt, zu begrenzen:
Nachdem Sie den API-Schlüssel konfiguriert und auf die Schaltfläche „Speichern“ geklickt haben, wird Ihnen der vollständige API-Schlüssel einmal angezeigt. Stellen Sie sicher, dass Sie den Schlüssel kopieren, da es keine Möglichkeit gibt, den vollständigen Schlüssel erneut anzuzeigen.
API-Geltungsbereiche in Discourse können nur einschränken, welche Aktionen ein API-Schlüssel relativ zu den bestehenden Berechtigungen des Benutzers ausführen kann. Sie können keine zusätzlichen Berechtigungen gewähren, die über das hinausgehen, was der zugehörige Benutzer bereits besitzt.
Zusätzliche Lektüre
Details zu den Ratenbegrenzungen, die Discourse für API-Schlüssel anwendet: Global rate limits and throttling in Discourse.
Discourse API-Dokumentation: https://docs.discourse.org/.
Ein hilfreicher Leitfaden zur Strukturierung von API-Anfragen: How to reverse engineer the Discourse API.
-Symbol fahre.
