Introducción a la API
La API de Ferndesk te permite automatizar los flujos de trabajo de documentación y leer datos del centro de ayuda desde tus propias herramientas. Empieza aquí para crear una clave de API, realizar tu primera solicitud y encontrar los endpoints adecuados en la referencia.
Necesitas una clave de API antes de poder enviar solicitudes. Crea y administra claves desde Configuración → Desarrolladores → API.
Crear una clave de API
Abre Configuración, selecciona Desarrolladores y, luego, API. Crea una nueva clave de API, cópiala cuando aparezca y guárdala en un administrador seguro de secretos. Ferndesk solo muestra la clave completa cuando se crea por primera vez.
Si necesitas instrucciones paso a paso sobre la interfaz de usuario, consulta Administrar claves de API.
Autenticar solicitudes
Envía tu clave de API como un token Bearer en el encabezado Authorization.
curl -H "Authorization: Bearer fdsk_your_api_key" \
https://api.ferndesk.com/v1/articlesReemplaza la clave de ejemplo por tu propia clave. Mantén las claves de API en secreto y revoca cualquier clave que haya quedado expuesta o que ya no necesites.
Realizar tu primera solicitud
Un primer paso sencillo es enumerar artículos o secciones para confirmar que la autenticación funciona.
Usa la referencia de la API para encontrar los formatos de las solicitudes, los parámetros y ejemplos de respuestas para cada endpoint.
Qué puedes hacer con la API
Leer contenido del centro de ayuda, como artículos y secciones
Crear y administrar tareas para el trabajo de documentación
Trabajar con contenido mediante programación desde tus propios sistemas
Formatos del contenido de los artículos
Lee el contenido de los artículos como contentHtml (el valor predeterminado), contentMarkdown o contentJson, seleccionados mediante el parámetro de consulta ?format= en los endpoints de artículos.
Los bloques de archivos (archivos descargables alojados en un artículo) son nodos de tipo file con src, name, size, mimeType y un caption opcional. En contentMarkdown, un bloque de archivos se muestra como un enlace al archivo con su tipo y tamaño entre paréntesis, y su descripción, si la tiene, aparece en un nuevo párrafo entre guiones bajos.
La API nunca carga bytes de archivos. Para escribir un nodo de archivo, proporciona una ruta alojada existente de Ferndesk como src. Las imágenes son diferentes: la API carga automáticamente las fuentes de imagen; consulta Cargas de imágenes.
Qué leer a continuación
Abre la referencia de la API para consultar los detalles y ejemplos de los endpoints. Si primero estás configurando las credenciales, revisa Administrar claves de API.