Ferndesk

Traducciones de artículos

Crear o actualizar una traducción

Prepara un borrador de traducción para un locale. Pasa publish: true para publicarlo inmediatamente. Requiere el scope content:write (para publicar, el borrador también debe ser válido).

Scope requerido: content:write

PUT /articles/{id}/translations/{locale}

Crear o actualizar una traducción

curl --request PUT \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/translations/{LOCALE}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "value"
}'
{
  "articleId": "<string>",
  "language": "<string>",
  "draftId": "<string>",
  "published": true
}

Traducción preparada/publicada

Authorizations

  • Authorization string obligatorio header

    Todas las solicitudes requieren un token Bearer en el encabezado Authorization. Las API keys llevan el prefijo fdsk_ y deben mantenerse secretas. Puedes generar y administrar claves desde la página de 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, retirar la publicación, restaurar y eliminar contenido (hacer efectivos los cambios)
    • analytics:read: Leer informes, analíticas 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

    Otorgar content:write o content:publish implica content:read. Las claves creadas antes de la definición de scopes tienen null scopes = acceso completo (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 va a recuperar. Ejemplo: en

Request Body

application/json
  • title string
  • content any

    Carga útil del documento JSON. Para los artículos, normalmente es un objeto de texto enriquecido con el estilo de ProseMirror/Tiptap. Los valores src de los nodos de imagen pueden ser rutas de recursos de Ferndesk, URL de imágenes externas o valores data:image/...;base64,...; las URL externas y las imágenes en base64 se cargan y se reescriben como rutas de recursos de Ferndesk al escribir.

  • markdown string
  • publish boolean default

    Publicar la traducción inmediatamente después de prepararla. Default: false.

Response

application/json
  • articleId string

    Artículo al que pertenece la traducción.

  • language string

    Locale de la traducción.

  • draftId string

    ID del borrador de traducción preparado.

  • published boolean

    Indica si la traducción se publicó (true) o solo se preparó (false).