Las claves de API se generan en la página Admin / API. Vaya a Admin-Advanced-API Keys:
Después de hacer clic en el botón “New API Key”, accederá a una página para configurar la clave:
Cada clave de API necesita una descripción, un nivel de usuario y un alcance.
Descripción
La descripción puede ser cualquier cosa que usted elija.
Nivel de Usuario
El menú desplegable User Level le permite seleccionar “All Users” o “Single User”. Si se selecciona “All Users”, la clave se puede usar en nombre de cualquier usuario. Esto se hace estableciendo el usuario en cuyo nombre está realizando la solicitud como Api-Username en las cabeceras de la solicitud. (Consulte el ejemplo de Autenticación en la documentación de la API para obtener detalles sobre cómo configurar las cabeceras de la solicitud).
Si se selecciona “Single User”, aparecerá un campo de usuario en el formulario. Ingrese el nombre de usuario para el que está generando la clave de API en ese campo:
Alcance
El menú desplegable Scope le permite seleccionar “Granular”, “Read-only” o “Global” como alcance.
Si se selecciona “Read-only” como alcance, la clave de API solo se podrá usar para realizar solicitudes GET. La clave podrá realizar cualquier solicitud GET que el usuario para el que se generó la clave, o el nombre de usuario que se ingrese como Api-Username de la solicitud, tenga permiso para realizar.
Si se selecciona “Global” como alcance, la clave se puede usar para cualquier solicitud que el usuario para el que se generó la clave, o el nombre de usuario que se ingrese como Api-Username de la solicitud, tenga permiso para realizar.
Si se selecciona “Granular” como alcance, se abrirá un formulario que le permitirá seleccionar entre los alcances disponibles. Pase el cursor sobre el icono de signo de interrogación de un alcance para ver una descripción del mismo. Haga clic en el icono de enlace del alcance para ver una lista de rutas y métodos de solicitud que el alcance admite. Tenga en cuenta que muchos de los alcances le permiten ingresar un parámetro adicional para limitar a qué rutas del sitio permitirá el acceso el alcance:
Después de configurar la clave de API y hacer clic en el botón Guardar, se le mostrará la clave de API completa una vez. Asegúrese de copiar la clave, ya que no hay forma de volver a ver la clave completa.
Los alcances de API en Discourse solo pueden restringir las acciones que una clave de API puede realizar en relación con los permisos existentes del usuario. No pueden otorgar permisos adicionales más allá de lo que el usuario asociado ya tiene.
Lectura adicional
Detalles sobre los límites de tasa que Discourse aplica a las claves de API: Límites de tasa globales y limitación en Discourse.
Documentación de la API de Discourse: https://docs.discourse.org/.
Una guía útil para descubrir cómo estructurar las solicitudes de API: Cómo realizar ingeniería inversa de la API de Discourse.
.
