vicket
Commencer
Concepts / Nº 02

Centre d'aide

Le centre d'aide porte deux types de contenu : les articles (markdown long format pour les guides, tutoriels, dépannage) et les FAQ (paires question/réponse courtes pour les questions les plus fréquentes). Les deux se rédigent dans le dashboard, se publient par site, et sont affichés par votre page de support pour que vos utilisateurs trouvent la réponse avant d'ouvrir un ticket.

Articles

Un article a un titre, un slug dérivé côté serveur, un extrait optionnel, un corps markdown et un statut de publication. Rédigez-les sous Articles dans le dashboard ; l'éditeur supporte le markdown avec upload d'images.

{
  "id": "0d2f7a9e-...",
  "site_id": null,
  "slug": "reset-your-api-key",
  "title": "How to reset your API key",
  "excerpt": "Rotate the key from the dashboard in two clicks.",
  "body_markdown": "## Reset your key\n\nFrom Websites, open your site...",
  "status": "published",
  "view_count": 1284
}

site_id à null signifie que l'article est visible sur tous les sites de l'org ; renseignez-le pour limiter l'article à un site.

FAQ

Les FAQ sont pensées pour un rendu en ligne sur la page de support : une question, une réponse courte en markdown, et une position qui contrôle l'ordre d'affichage. Ajoutez-les depuis le composeur rapide de la page FAQ.

{
  "id": "7c1b42d0-...",
  "question": "Is my data encrypted at rest?",
  "answer_markdown": "Yes. All ticket data is encrypted...",
  "status": "published",
  "position": 0
}

Statut de publication

Articles et FAQ partagent le même cycle de vie :

ValeurComportement
draftVisible uniquement des agents dans le dashboard. Peut être vide.
publishedVisible sur votre page de support. Publier exige un contenu.
archivedMasqué de la page de support, conservé pour l'historique.

Les endpoints publics (/support/v1/help/...) ne retournent jamais que des enregistrements published : aucun brouillon ne fuite, même si un slug est deviné.

Compteurs de vues

Les lectures d'articles via l'API publique incrémentent view_count. Votre page de support s'en sert pour classer les "Popular Articles" en premier ; le dashboard l'affiche pour repérer ce que vos utilisateurs cherchent vraiment.

La suite