Ferndesk

Traductions d’articles

Créer ou mettre à jour une traduction

Prépare un brouillon de traduction pour une locale. Passez publish: true pour la publier immédiatement. Nécessite le scope content:write (la publication nécessite également que le brouillon soit valide).

Scope requis : content:write

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

Créer ou mettre à jour une traduction

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
}

Traduction préparée/publiée

Authorizations

  • Authorization string requis header

    Toutes les requêtes nécessitent un token Bearer dans l’en-tête Authorization. Les clés API sont préfixées par fdsk_ et doivent rester secrètes. Vous pouvez générer et gérer les clés depuis la page Paramètres développeur.

    Les clés peuvent être limitées à n’importe quel sous-ensemble de ces scopes (chaque endpoint indique le scope requis via x-required-scopes) :

    • content:read : Lire et rechercher les articles, collections, sections et traductions du centre d’aide
    • content:write : Créer et modifier des brouillons d’articles, des utilisateurs et des tâches ; déplacer des articles et des collections
    • content:publish : Publier, dépublier, restaurer et mettre à la corbeille du contenu (rendre les modifications visibles)
    • analytics:read : Lire les rapports, analyses et retours sur les articles du centre d’aide
    • conversations:read : Lire les conversations et transcriptions de l’assistant IA
    • webhooks:manage : Créer et gérer les abonnements aux webhooks sortants

    L’attribution de content:write ou content:publish implique content:read. Les clés créées avant la mise en place des scopes ont des scopes null = accès complet (mode legacy).

Path Parameters

  • id string requis

    ID de ressource de l’entité demandée. Exemple: art_01JXY9AZK4KV

  • locale string requis

    Code de locale de la traduction à récupérer. Exemple: en

Request Body

application/json
  • title string
  • content any

    Charge utile de document JSON. Pour les articles, il s’agit généralement d’un objet de texte enrichi de type ProseMirror/Tiptap. Les valeurs src des nœuds d’image peuvent être des chemins d’assets Ferndesk, des URL d’images externes ou des valeurs data:image/...;base64,... ; les URL externes et les images base64 sont téléversées et réécrites en chemins d’assets Ferndesk lors de l’écriture.

  • markdown string
  • publish boolean default

    Publier la traduction immédiatement après sa préparation. Default: false.

Response

application/json
  • articleId string

    Article auquel appartient la traduction.

  • language string

    Locale de la traduction.

  • draftId string

    ID du brouillon de traduction préparé.

  • published boolean

    Indique si la traduction a été publiée (true) ou seulement préparée (false).