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をリバースエンジニアリングする方法。
アイコンにカーソルを合わせたときにツールチップが表示されなくなりました。
