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