Ключи API генерируются на странице Администрирование / API. Перейдите в раздел Администрирование-Дополнительно-Ключи API:
После нажатия кнопки «Добавить ключ API» вы перейдете на страницу настройки ключа:
Каждый ключ API должен иметь описание, уровень пользователя и область действия.
Описание
Описание может быть любым по вашему выбору.
Уровень пользователя
В выпадающем списке «Уровень пользователя» вы можете выбрать «Все пользователи» или «Один пользователь». Если выбрано «Все пользователи», ключ может использоваться от имени любого пользователя. Это делается путем установки пользователя, от имени которого выполняется запрос, в заголовок запроса как Api-Username. (Подробнее о том, как устанавливать заголовки запросов, см. в примере аутентификации в документации API.)
Если выбрано «Один пользователь», на форме появится поле для ввода пользователя. Введите имя пользователя, для которого вы создаете ключ API, в это поле:
Область действия
В выпадающем списке «Область действия» вы можете выбрать «Глобальная», «Только чтение» или «Детализированная».
Если выбрана «Глобальная» область действия, ключ может использоваться для любых запросов, которые пользователь, для которого был сгенерирован ключ, или имя пользователя, указанное в заголовке запроса как Api-Username, имеет право выполнять.
Если выбрана область действия «Только чтение», ключ API можно будет использовать только для выполнения GET-запросов. Ключ сможет выполнять любые GET-запросы, которые пользователь, для которого был сгенерирован ключ, или имя пользователя, указанное в заголовке запроса как Api-Username, имеет право выполнять.
Если выбрана «Детализированная» область действия, откроется форма, позволяющая выбрать из доступных областей действия. Наведите курсор на значок вопроса рядом с областью действия, чтобы увидеть её описание. Нажмите на значок ссылки области действия, чтобы увидеть список путей и методов запросов, поддерживаемых этой областью действия. Обратите внимание, что многие области действия позволяют указать дополнительный параметр для ограничения путей на сайте, к которым будет разрешен доступ:
После настройки ключа API и нажатия кнопки «Сохранить» полный ключ API будет показан вам один раз. Обязательно скопируйте ключ, так как просмотреть его полностью повторно невозможно.
Области действия API в Discourse могут только ограничивать действия, которые может выполнять ключ API, относительно существующих разрешений пользователя. Они не могут предоставлять дополнительные разрешения сверх тех, что уже есть у связанного пользователя.
revoke_api_keys_unused_days.
Дополнительная литература
Подробности о лимитах скорости, которые Discourse применяет к ключам API: Глобальные лимиты скорости и ограничение частоты запросов в Discourse.
Документация по API Discourse: https://docs.discourse.org/.
Полезное руководство по структуре API-запросов: Как провести реверс-инжиниринг API Discourse.
icon.
