Ferndesk

Révisions d’articles

Obtenir une révision d’article

Renvoie un instantané complet de la révision. Utilisez format=markdown pour Markdown. Nécessite la portée content:read.

Portée requise : content:read

GET /articles/{id}/revisions/{revisionId}

Obtenir une révision d’article

curl --request GET \
  --url 'https://api.ferndesk.com/v1/articles/{ID}/revisions/{REVISIONID}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "id": "<string>",
  "version": 1,
  "title": "<string>",
  "source": "<string>",
  "comment": "<string>",
  "createdAt": "<string>",
  "language": "<string>",
  "contentHtml": "<string>",
  "contentMarkdown": "<string>",
  "contentJson": "<string>"
}

Révision

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 du développeur.

    Les clés peuvent être limitées à n’importe quel sous-ensemble de ces portées (chaque endpoint indique la portée requise 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 supprimer définitivement du contenu (rendre les modifications effectives)
    • 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 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 portées ont des portées nulles, ce qui accorde un accès complet (mode legacy).

Path Parameters

  • id string requis

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

  • revisionId string requis

    ID de la révision. Exemple: rev_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 de la révision.

  • version integer

    Version de l’article capturée par cette révision.

  • title string | null
  • source string | null

    Canal d’écriture de la publication.

  • comment string | null
  • createdAt string

    Horodatage ISO 8601 en UTC.

  • language string

    Langue de la révision.

  • contentHtml string
  • contentMarkdown string
  • contentJson any | null

    Instantané brut de la révision ProseMirror/Tiptap stockée (format=json). Schéma ProseMirror Ferndesk sans perte.