Ferndesk

Traducciones de artículos

Obtener traducción del artículo

Devuelve la versión localizada de un artículo para un locale específico. Usa format=markdown para Markdown. Requiere el ámbito content:read.

Ámbito requerido: content:read

GET /articles/{id}/translations/{locale}

Obtener traducción del artículo

curl --request GET \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/translations/{LOCALE}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "articleId": "<string>",
  "language": "<string>",
  "title": "<string>",
  "contentHtml": "<string>",
  "contentMarkdown": "<string>",
  "contentJson": "<string>",
  "url": "<url>",
  "status": "<string>",
  "updatedAt": "<string>"
}

Traducción del artículo

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 ámbitos (cada endpoint indica el ámbito 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, retirar la publicación, restaurar y enviar contenido a la papelera (hacer que los cambios sean visibles)
    • 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 creadas antes de la definición de ámbitos tienen ámbitos null = acceso total (modo heredado).

Path Parameters

  • id string obligatorio

    ID del recurso de la entidad solicitada. Ejemplo: art_01JXY9AZK4KV

  • locale string obligatorio

    Código de locale de la traducción que se recuperará. Ejemplo: en

Query Parameters

  • format string enum

    Formato de renderizado 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
  • articleId string

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

  • language string

    Código de idioma de esta traducción.

  • title string

    Título localizado del artículo.

  • contentHtml string

    Contenido localizado del artículo renderizado como HTML. Presente cuando format=html (predeterminado).

  • contentMarkdown string

    Contenido localizado del artículo renderizado como Markdown. Presente cuando format=markdown.

  • contentJson any | null

    Documento ProseMirror/Tiptap sin procesar almacenado. Presente cuando format=json. Usa el esquema ProseMirror de Ferndesk (nodos personalizados como callout, steps y cards) y es la representación sin pérdida.

  • url string (uri) | null

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

  • status string

    Estado del ciclo de vida de la traducción.

  • updatedAt string

    Marca de tiempo ISO 8601 en UTC.