Administrar claves de API
Las claves de API autentican las solicitudes a la API de Ferndesk. Al crear una clave, elige un ajuste preestablecido de acceso o permisos personalizados para que la clave solo obtenga los permisos que necesita.
Trata cada clave como un secreto. Nunca confirmes claves en el control de versiones. Revoca una clave inmediatamente si queda expuesta.
Crear una clave de API
Haz clic en API en la barra lateral izquierda, dentro de Desarrolladores.
Haz clic en Nueva clave de API.
Introduce un Nombre de clave (por ejemplo, Producción o canalización de CI/CD).
En Permisos, elige un ajuste preestablecido:
Acceso completo: leer, escribir y publicar contenido, además de acceder a analíticas, conversaciones de IA y webhooks.
Solo lectura: leer contenido, analíticas y conversaciones de IA. No se puede cambiar nada.
Personalizado: elige permisos individuales con las casillas que aparecen a continuación.
Haz clic en Crear clave.
En Guarda tu clave de API, copia el valor que aparece debajo de Tu nueva clave de API y haz clic en Listo.
Esta clave no volverá a mostrarse. Cópiala en un lugar seguro antes de cerrar el cuadro de diálogo.
Permisos personalizados
Cuando elijas Personalizado, selecciona uno o varios de estos permisos:
Permiso | Qué permite |
|---|---|
Leer contenido | Artículos, colecciones, revisiones y traducciones |
Escribir contenido | Crear y editar borradores y colecciones, mover artículos y enviar artículos a la papelera |
Publicar | Publicar borradores, anular publicaciones y restaurar revisiones |
Leer analíticas | Informes y comentarios sobre artículos |
Leer conversaciones de IA | Transcripciones de conversaciones de los usuarios finales |
Administrar webhooks | Registrar y administrar endpoints de webhook |
Seleccionar Escribir contenido o Publicar siempre incluye Leer contenido. La casilla de lectura permanece activada y muestra Requerido por Escribir contenido y Publicar. Debes seleccionar al menos un permiso antes de poder crear una clave personalizada.
Ver tus claves de API
Todas las claves aparecen en la página de API con el nombre de la clave, el creador, la hora de creación, la hora del último uso y las insignias de permisos.
Las claves con permisos muestran insignias compactas como lectura, escritura, publicación, analíticas, conversaciones y webhooks.
Las claves creadas antes de que existieran los permisos muestran Heredada · acceso completo. Esas claves funcionan con acceso completo y utilizan el formato de respuesta de API heredado. Crea una nueva clave con permisos, actualiza tu integración y, a continuación, revoca la clave heredada.
El secreto completo de la clave no vuelve a mostrarse después de su creación.
Revocar una clave de API
Ve a la página de API.
Abre el menú situado junto a la clave y selecciona Revocar.
Confirma en el cuadro de diálogo Revocar clave de API.
Revocar una clave bloquea inmediatamente todas las solicitudes que la utilicen.
Rota las claves con regularidad y revoca las que no uses. Prefiere Solo lectura o un conjunto Personalizado mínimo cuando un flujo de trabajo no necesite acceso de escritura o publicación.
Para saber cómo enviar una clave en las solicitudes a la API, consulta Autenticación.