API キーは、管理 / API ページから生成されます。管理 - 詳細設定 - API キーに移動します。
「新しい API キー」ボタンをクリックすると、キーを設定するページに移動します。
すべての API キーには、説明、ユーザーレベル、スコープが必要です。
説明
説明は、任意に選択できます。
ユーザーレベル
「ユーザーレベル」ドロップダウンでは、「すべてのユーザー」または「単一ユーザー」を選択できます。「すべてのユーザー」が選択されている場合、キーは任意のユーザーの代わりに機能します。これは、要求しているユーザーを要求ヘッダーの Api-Username として設定することによって行われます。（要求ヘッダーの設定方法の詳細については、API ドキュメントの認証の例を参照してください。）
「単一ユーザー」が選択されている場合、フォームにユーザーフィールドが表示されます。そのフィールドに、API キーを生成するユーザーのユーザー名を入力します。
スコープ
「スコープ」ドロップダウンでは、「粒度別」、「読み取り専用」、または「グローバル」をスコープとして選択できます。
スコープとして「読み取り専用」が選択されている場合、API キーは GET 要求のみを行うために使用できます。キーは、キーが生成されたユーザー、または要求の Api-Username として入力されたユーザーが実行する権限を持つ任意の GET 要求を行うことができます。
スコープとして「グローバル」が選択されている場合、キーは、キーが生成されたユーザー、または要求の Api-Username として入力されたユーザーが実行する権限を持つ すべての要求 に使用できます。
スコープとして「粒度別」が選択されている場合、利用可能なスコープから選択できるフォームが開きます。スコープの疑問符アイコンにカーソルを合わせると、スコープの説明が表示されます。スコープのリンクアイコンをクリックすると、スコープがサポートするパスと要求メソッドのリストが表示されます。多くのスコープでは、スコープがサイトのどのパスへのアクセスを許可するかを制限する追加のパラメーターを入力できることに注意してください。
API キーを設定し、「保存」ボタンをクリックすると、完全な API キーが一度だけ表示されます。完全なキーを再度表示する方法はないため、必ずコピーしてください。
Discourse の API スコープは、API キーがユーザーの既存の権限に対して実行できるアクションを 制限する ことしかできません。関連付けられたユーザーが既に持っている権限を超える権限を 付与する ことはできません。
追加資料
Discourse が API キーに適用するレート制限の詳細については、Discourse のグローバルレート制限とスロットリングを参照してください。
Discourse API ドキュメント: https://docs.discourse.org/。
API 要求の構造化方法を理解するのに役立つガイド: Discourse API のリバースエンジニアリング方法。
アイコンにカーソルを合わせたときにツールチップが表示されなくなりました。
