API de la documentation : recherche et avis

Routes HTTP utilisées par le lecteur Communik : paramètres, exemples JavaScript et cURL, réponses et erreurs.

Publié le 01/10/2026

Rechercher des articles

Recherche dans les articles publiés que le lecteur a le droit de consulter. Le domaine du site détermine le projet. Les brouillons sont exclus et les accès privés respectent la session du lecteur.

Paramètres de recherche

Paramètre	Type	Détail
`q`	string	Texte recherché, limité à 120 caractères. Vide : aucun résultat.
`lang`	string	Langue de la documentation, par exemple `fr`.
`version`	string	Version de documentation, par exemple `current`.

Résultat

Champ	Type	Détail
`data.term`	string	Terme recherché après normalisation.
`data.results`	array	Jusqu’à 30 articles classés par pertinence.
`id`	string	Identifiant de l’article.
`title`	string	Titre publié.
`summary`	string	Résumé publié.
`sectionSlug`	string	Segment de rubrique pour construire le lien.
`slug`	string	Segment de l’article.
`snippet`	string	Extrait textuel du contenu.
`score`	number	Score interne de classement.

GET/api/modules/documentation/search

Exemples de requête

curl --get "https://www.communik.io/api/modules/documentation/search" \
  --data-urlencode "q=MCP" \
  --data-urlencode "lang=fr" \
  --data-urlencode "version=current"

Exemples de réponse

{
  "data": {
    "term": "terme-inconnu",
    "results": []
  }
}

Donner un avis sur une page

Enregistre si une page publiée a été utile. Appelez cette route depuis le site qui héberge la documentation : les requêtes d’une autre origine sont refusées.

Corps JSON

Champ	Type	Détail
`articleId`	string	Obligatoire. Identifiant numérique d’un article publié accessible au lecteur.
`locale`	string	Obligatoire. Langue de l’article, par exemple `fr`.
`helpful`	boolean	Obligatoire. `true` si utile, `false` sinon.

Retours

Cas	Résultat
Vote enregistré	`data.recorded: true`
Aperçu sur un sous-domaine de recette	`data.recorded: false`, `data.preview: true`
Corps invalide	Erreur 400
Origine différente	Erreur 403
Article absent, non publié ou inaccessible	Erreur 404

POST/api/modules/documentation/feedback

Exemples de requête

async function vote(articleId, helpful) {
  const response = await fetch("/api/modules/documentation/feedback", {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({ articleId, locale: "fr", helpful })
  });
  if (!response.ok) throw new Error("Vote non enregistré");
  return response.json();
}

Exemples de réponse

{
  "data": { "recorded": true }
}