Clustraly
Jetons API, webhooks & API REST

Donnez à vos apps une vraie recherche plein texte : l'API REST publique /api/v1/search

API REST publique recherche (/api/v1/search) une fonctionnalité du module Jetons API, webhooks & API REST de Clustraly. L'API REST publique /api/v1/search interroge en plein texte votre contenu Clustraly publié, avec langue, pagination et suggestions orthographiques, sous authentification Bearer et scope content:read.

Vos applications interrogent votre contenu publié en une seule requête. L'IA propose des corrections orthographiques, vous décidez de ce que vous affichez le tout sous jeton, scope et re-filtrage de sécurité.

Recherche prête à l'emploi

Une recherche plein texte, exposée proprement à vos applications

Offrez à vos sites, apps mobiles et intégrations une vraie barre de recherche sur votre contenu Clustraly. Un seul appel GET /api/v1/search?q= interroge un index déjà construit et vous renvoie des résultats structurés, prêts à afficher.

Vous branchez, vos utilisateurs trouvent. Pas de moteur à héberger côté client ni d'index à recalculer à chaque frappe.

  • Endpoint unique : GET /api/v1/search?q=
  • Recherche sur l'index préconstruit de votre contenu
  • Résultats structurés en JSON, prêts à intégrer
  • Minimum 2 caractères avant de lancer la requête
Fonctionnement

De la requête au résultat, en un seul appel

Passez votre terme dans ?q= (au moins 2 caractères) et récupérez une réponse paginée. Vous parcourez les pages de résultats à votre rythme, sans tout charger d'un coup.

La recherche s'appuie sur un index déjà construit côté serveur : votre appel se contente d'interroger, pas de reconstruire.

  • Terme via ?q=, seuil de 2 caractères
  • Réponse paginée, page après page
  • Interrogation d'un index déjà construit
  • Format JSON exploitable directement
Suggestions & corrections

Moins d'impasses : la recherche propose une correction

Quand une requête tombe à côté, la réponse peut inclure une métadonnée de suggestion ou de correction orthographique. Vous affichez un « Vouliez-vous dire… ? » et vous gardez l'utilisateur dans le flux.

L'IA propose la correction, vous décidez de l'afficher, de la pré-remplir ou de l'ignorer.

  • Métadonnée de suggestion orthographique dans la réponse
  • Idéal pour un « Vouliez-vous dire… ? »
  • Vous restez maître de l'affichage
Multilingue & volume

Cherchez dans la bonne langue, page après page

Ciblez une langue avec ?lang et servez à chaque visiteur des résultats dans sa langue, depuis le même endpoint.

Combinée à la pagination, la recherche reste lisible même sur de gros catalogues de contenu.

  • Filtre de langue via ?lang
  • Résultats servis dans la langue demandée
  • Pagination sur les grands catalogues
  • Un seul endpoint pour toutes les langues
Cas d'usage

Une barre de recherche, partout où vous en avez besoin

Alimentez la recherche de votre site vitrine, d'une app mobile, d'un intranet ou d'un assistant. Comme l'endpoint renvoie du JSON structuré, vous branchez la même source sur autant de front-ends que vous voulez.

Autocomplétion, page de résultats, recherche embarquée dans un chatbot : à vous de composer l'expérience.

  • Barre de recherche de site ou d'app
  • Autocomplétion et « type-ahead »
  • Recherche embarquée dans un assistant
  • Une source, plusieurs front-ends
Garde-fous

Public ne veut pas dire ouvert à tous

Chaque requête exige un jeton Bearer valide et le scope content:read ; sinon, l'accès est refusé. En défense en profondeur, les résultats sont re-filtrés en direct (dropNonPublic) pour écarter tout article ou page non public.

Une limitation de débit par jeton protège l'endpoint des rafales, et la sérialisation ne renvoie que des champs autorisés jamais vos objets internes.

  • Authentification Bearer obligatoire
  • Scope content:read requis
  • Re-filtrage dropNonPublic (défense en profondeur)
  • Limitation de débit par jeton
Pourquoi ça compte

L'IA propose, vous décidez

La recherche suggère une correction orthographique et remonte les résultats ; c'est votre application qui choisit ce qu'elle affiche, dans quelle langue et à quel rythme. Vous gardez la main sur l'expérience, Clustraly verrouille l'accès.

FAQ

Questions fréquentes

Quel scope faut-il pour appeler /api/v1/search ?
Le scope content:read, présenté via un jeton Bearer valide. Sans en-tête Authorization correct, l'API refuse la requête ; sans le bon scope, l'accès est bloqué.
La recherche peut-elle renvoyer du contenu non publié ?
Non. Le périmètre reste publié et public, et les résultats sont re-filtrés en direct par dropNonPublic pour retirer tout article ou page non public une défense en profondeur qui s'ajoute au filtrage initial.
Comment gérer plusieurs langues ?
Ajoutez le paramètre ?lang à votre requête pour cibler une langue. Vous servez ainsi à chaque visiteur des résultats dans sa langue, depuis le même endpoint.
Que se passe-t-il si l'utilisateur fait une faute de frappe ?
La réponse peut inclure une métadonnée de suggestion ou de correction orthographique. Vous l'exploitez pour proposer un « Vouliez-vous dire… ? » et éviter les résultats vides. Rappel : la requête démarre à partir de 2 caractères.
Prêt à commencer ?

Prêt à brancher la recherche sur vos apps ?

Créez un jeton avec le scope content:read, appelez GET /api/v1/search?q= et laissez vos utilisateurs trouver votre contenu dans leur langue, avec suggestions à la clé et un accès verrouillé par jeton. L'IA propose, vous décidez de l'expérience.