Obtenir la traduction d’un article

Authorizations

• Authorization string requis header

  Toutes les requêtes nécessitent un jeton 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 les brouillons d’articles, utilisateurs et tâches ; déplacer des articles et des collections
  • content:publish : publier, dépublier, restaurer et supprimer définitivement du contenu (rendre les modifications visibles)
  • analytics:read : consulter les rapports, analyses et retours sur les articles du centre d’aide
  • conversations:read : consulter les conversations et transcriptions de l’assistant IA
  • webhooks:manage : créer et gérer les abonnements aux webhooks sortants

  Accorder 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 hérité).

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

Query Parameters

• format string enum

  Format de rendu du contenu. html (par défaut) renvoie contentHtml ; markdown renvoie contentMarkdown ; json renvoie contentJson — le document ProseMirror/Tiptap brut stocké. Le JSON utilise le schéma ProseMirror de Ferndesk (nœuds personnalisés tels que callout, steps et cards) et constitue la représentation sans perte du corps de l’article. Exemple: markdown

• articleId string

  ID d’article Ferndesk (art_...).

• language string

  Code de langue de cette traduction.

• title string

  Titre localisé de l’article.

• contentHtml string

  Contenu localisé de l’article rendu en HTML. Présent lorsque format=html (par défaut).

• contentMarkdown string

  Contenu localisé de l’article rendu au format Markdown. Présent lorsque format=markdown.

• contentJson any | null

  Document ProseMirror/Tiptap brut stocké. Présent lorsque format=json. Utilise le schéma ProseMirror de Ferndesk (nœuds personnalisés tels que callout, steps et cards) et constitue la représentation sans perte.

• url string (uri) | null

  URL publique canonique de cet article traduit.

• status string

  Statut du cycle de vie de la traduction.

• updatedAt string

  Horodatage ISO 8601 en UTC.