Introducción
La API de Ferndesk le permite automatizar los flujos de trabajo de documentación y leer los datos del centro de ayuda desde sus propias herramientas. Comience aquí para crear una clave de API, realizar su primera solicitud y encontrar los puntos de conexión adecuados en la referencia.
Necesita una clave de API antes de poder enviar solicitudes. Cree y gestione las claves desde la configuración de desarrollador en la aplicación Ferndesk.
Crear una clave de API
Abra la configuración de su cuenta y vaya a Developer settings. Cree una nueva clave de API, cópiela cuando aparezca y guárdela en un gestor de secretos seguro. Ferndesk solo muestra la clave completa cuando se crea por primera vez.
Si necesita instrucciones paso a paso sobre la interfaz de usuario, consulte Manage API keys.
Autenticar solicitudes
Envíe su clave de API como un token Bearer en el encabezado Authorization.
curl -H "Authorization: Bearer fdsk_your_api_key" \
https://api.ferndesk.com/articlesSustituya la clave de ejemplo por su propia clave. Mantenga las claves de API en secreto y revoque cualquier clave que quede expuesta o que ya no sea necesaria.
Realizar su primera solicitud
Un primer paso sencillo es enumerar artículos o secciones para confirmar que su autenticación funciona.
Utilice la referencia de la API para encontrar formatos de solicitud, parámetros y ejemplos de respuesta para cada punto de conexión.
Qué puede hacer con la API
Leer el contenido del centro de ayuda, como artículos y secciones
Crear y gestionar tareas para el trabajo de documentación
Trabajar con el contenido de forma programática desde sus propios sistemas
Qué leer a continuación
Abra la referencia de la API para obtener detalles y ejemplos de los puntos de conexión. Si primero está configurando las credenciales, revise Manage API keys.