Ferndesk

Artículos

Crear artículo

Crea un nuevo artículo del centro de ayuda y lo publica de inmediato. Opcionalmente, puede asignarlo a una colección, establecer metadatos de SEO y proporcionar un slug personalizado.

Límite de velocidad: 60 solicitudes por hora por clave de API.

POST /articles

Crear artículo

curl --request POST \
  --url 'https://api.ferndesk.com/v1/articles' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "id": "<string>",
  "title": "<string>",
  "contentHtml": "<string>",
  "url": "<url>",
  "sectionId": "<string>",
  "collectionId": "<string>",
  "status": "<string>",
  "publishedAt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Artículo creado

Authorizations

  • Authorization string obligatorio header

    Todas las solicitudes requieren un token Bearer en el encabezado Authorization. Las claves de API tienen el prefijo fdsk_ y deben mantenerse en secreto. Puede generar y administrar claves desde la página de Configuración de desarrolladores.

Request Body

application/json
  • title string obligatorio

    Título del artículo.

  • subtitle string | null

    Subtítulo opcional del artículo.

  • content any

    Carga útil del contenido del artículo. Si se omite, se utiliza un cuerpo de borrador vacío.

  • sectionId string obligatorio

    ID de la sección donde se debe crear el artículo.

  • collectionId string | null

    ID de colección opcional para agrupar este artículo.

  • keywords string

    Palabras clave de SEO.

  • metaDescription string

    Metadescripción de SEO.

  • ogImage string

    URL de la imagen de Open Graph.

  • slug string

    Slug de URL personalizado. Proporcionar un nuevo slug activa automáticamente el modo de slug personalizado.

Response

application/json
  • id string

    ID de artículo de Ferndesk (art_...).

  • title string

    Título principal del artículo.

  • contentHtml string

    Contenido del artículo renderizado como HTML.

  • url string (uri) | null

    URL pública canónica para este artículo.

  • sectionId string | null

    ID de la sección que contiene el artículo.

  • collectionId string | null

    ID de agrupación de colección opcional para el artículo.

  • status string | null

    Estado de publicación del artículo.

  • publishedAt string | null

    Marca de tiempo de cuando se publicó el artículo.

  • createdAt string

    Marca de tiempo ISO 8601 en UTC.

  • updatedAt string

    Marca de tiempo ISO 8601 en UTC.