Ferndesk

Brouillons d’articles

Obtenir un brouillon d’article

Renvoie un brouillon avec son contenu. Utilisez format=markdown pour le Markdown. Nécessite le scope content:write.

Scope requis : content:write

GET /articles/{id}/drafts/{draftId}

Obtenir un brouillon d’article

curl --request GET \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/drafts/{DRAFTID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "language": "<string>",
  "status": "<string>",
  "baseVersion": 1,
  "source": "<string>",
  "stale": true,
  "updatedAt": "<string>",
  "title": "<string>",
  "contentHtml": "<string>",
  "contentMarkdown": "<string>",
  "contentJson": "<string>"
}

Brouillon

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 des 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 des abonnements à des 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 hérité).

Path Parameters

  • draftId string requis

    ID du brouillon. Exemple: drft_01JXY9AZK4KV

  • id string requis

    ID d’article Ferndesk (art_...). Exemple: art_01JXY9AZK4KV

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 (avec des nœuds personnalisés tels que callout, steps et cards) et constitue la représentation sans perte du corps de l’article. Exemple: markdown

Response

application/json
  • id string

    ID du brouillon.

  • language string | null

    Langue du brouillon.

  • status string

    Statut du brouillon.

  • baseVersion integer

    Version de l’article sur laquelle le brouillon est basé.

  • source string | null

    Canal d’écriture à l’origine du brouillon.

  • stale boolean

    Indique si l’article a évolué depuis la création du brouillon (brouillons principaux uniquement).

  • updatedAt string

    Horodatage ISO 8601 en UTC.

  • title string | null

    Titre du brouillon.

  • contentHtml string

    Corps du brouillon au format HTML (format=html).

  • contentMarkdown string

    Corps du brouillon au format Markdown (format=markdown).

  • contentJson any | null

    Corps brut du brouillon ProseMirror/Tiptap stocké (format=json). Schéma ProseMirror sans perte de Ferndesk.