API-Schlüssel werden auf der Seite Admin / API generiert. Gehe zu Admin-Advanced-API Keys:
Nachdem du auf die Schaltfläche “New API Key” geklickt hast, gelangst du zu einer Seite, auf der du den Schlüssel konfigurieren kannst:
Jeder API-Schlüssel benötigt eine Beschreibung, eine Benutzerebene und einen Geltungsbereich.
Beschreibung
Die Beschreibung kann beliebig gewählt werden.
Benutzerebene
Das Dropdown-Menü “User Level” ermöglicht es dir, entweder “All Users” oder “Single User” auszuwählen. Wenn “All Users” ausgewählt ist, kann der Schlüssel im Namen jedes Benutzers verwendet werden. Dies geschieht durch Festlegen des Benutzers, in dessen Namen du die Anfrage stellst, als Api-Username in den Anfrageheadern. (Siehe das Authentifizierungsbeispiel in der API-Dokumentation für Details zum Festlegen der Anfrageheader.)
Wenn “Single User” ausgewählt ist, erscheint ein Feld für den Benutzer im Formular. Gib in dieses Feld den Benutzernamen des Benutzers ein, für den du den API-Schlüssel generierst:
Geltungsbereich
Das Dropdown-Menü “Scope” ermöglicht es dir, entweder “Granular”, “Read-only” oder “Global” als Geltungsbereich auszuwählen.
Wenn “Read-only” als Geltungsbereich ausgewählt ist, kann der API-Schlüssel nur für GET-Anfragen verwendet werden. Der Schlüssel kann alle GET-Anfragen stellen, die der Benutzer, für den der Schlüssel generiert wurde, oder der als Api-Username in der Anfrage angegebene Benutzer ausführen darf.
Wenn “Global” als Geltungsbereich ausgewählt ist, kann der Schlüssel für alle Anfragen verwendet werden, die der Benutzer, für den der Schlüssel generiert wurde, oder der als Api-Username in der Anfrage angegebene Benutzer ausführen darf.
Wenn “Granular” als Geltungsbereich ausgewählt ist, öffnet sich ein Formular, in dem du aus den verfügbaren Geltungsbereichen auswählen kannst. Fahre mit der Maus über das Fragezeichen-Symbol eines Geltungsbereichs, um eine Beschreibung des Geltungsbereichs zu sehen. Klicke auf das Link-Symbol des Geltungsbereichs, um eine Liste der Pfade und Anfragemethoden anzuzeigen, die der Geltungsbereich unterstützt. Beachte, dass viele Geltungsbereiche es dir ermöglichen, einen zusätzlichen Parameter einzugeben, um die Pfade auf der Website, auf die der Geltungsbereich Zugriff gewährt, einzuschränken:
Nachdem du den API-Schlüssel konfiguriert und auf die Schaltfläche “Save” geklickt hast, wird dir der vollständige API-Schlüssel einmal angezeigt. Stelle sicher, dass du den Schlüssel kopierst, 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 hat.
Zusätzliche Lektüre
Details zu den Ratenbegrenzungen, die Discourse für API-Schlüssel anwendet: Globale Ratenbegrenzungen und Drosselung in Discourse.
Discourse API-Dokumentation: https://docs.discourse.org/.
Eine hilfreiche Anleitung zur Strukturierung von API-Anfragen: How to reverse engineer the Discourse API.
-Symbol fahre.
