Ferndesk

Revisiones de artículos

Obtener una revisión de artículo

Devuelve una instantánea completa de la revisión. Usa format=markdown para Markdown. Requiere el scope content:read.

Scope requerido: content:read

GET /articles/{id}/revisions/{revisionId}

Obtener una revisión de artículo

curl --request GET \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/revisions/{REVISIONID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "version": 1,
  "title": "<string>",
  "source": "<string>",
  "comment": "<string>",
  "createdAt": "<string>",
  "language": "<string>",
  "contentHtml": "<string>",
  "contentMarkdown": "<string>",
  "contentJson": "<string>"
}

Revisión

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. Puedes generar y administrar claves desde la página Configuración de desarrolladores.

    Las claves pueden restringirse a cualquier subconjunto de estos scopes (cada endpoint indica el scope que requiere mediante x-required-scopes):

    • content:read: Leer y buscar artículos, colecciones, secciones y traducciones del centro de ayuda
    • content:write: Crear y editar borradores de artículos, usuarios y tareas; mover artículos y colecciones
    • content:publish: Publicar, despublicar, restaurar y enviar contenido a la papelera (hacer efectivos los cambios)
    • analytics:read: Leer informes, análisis y comentarios sobre artículos del centro de ayuda
    • conversations:read: Leer conversaciones y transcripciones del asistente de IA
    • webhooks:manage: Crear y administrar suscripciones a webhooks salientes

    Conceder content:write o content:publish implica content:read. Las claves generadas antes de definir los scopes tienen scopes nulos = acceso completo (modo heredado).

Path Parameters

  • id string obligatorio

    ID del artículo de Ferndesk (art_...). Ejemplo: art_01JXY9AZK4KV

  • revisionId string obligatorio

    ID de la revisión. Ejemplo: rev_01JXY9AZK4KV

Query Parameters

  • format string enum

    Formato de representación del contenido. html (predeterminado) devuelve contentHtml; markdown devuelve contentMarkdown; json devuelve contentJson, el documento ProseMirror/Tiptap sin procesar almacenado. El JSON usa el esquema ProseMirror de Ferndesk (nodos personalizados como callout, steps y cards) y es la representación sin pérdida del cuerpo del artículo. Ejemplo: markdown

Response

application/json
  • id string

    ID de la revisión.

  • version integer

    Versión del artículo capturada por esta revisión.

  • title string | null
  • source string | null

    Canal de escritura de la publicación.

  • comment string | null
  • createdAt string

    Marca de tiempo ISO 8601 en UTC.

  • language string

    Idioma de la revisión.

  • contentHtml string
  • contentMarkdown string
  • contentJson any | null

    Instantánea de revisión ProseMirror/Tiptap sin procesar almacenada (format=json). Esquema ProseMirror de Ferndesk sin pérdidas.