aller au contenu principal
Parcourir la documentation

Clés d’API

Créez, affichez et révoquez les deux types de clés émises par Syncanix — une clé secrète pour la CLI et MCP, et une clé publiable pour le widget intégré.

Les clés d’API permettent à vos propres outils d’atteindre votre espace de travail. Il en existe deux types, et la différence compte : l’une est un secret côté serveur, l’autre peut être incluse sans risque dans votre page web.

Les deux types de clés

Clé secrète (gak_…)
Pleine capacité et côté serveur uniquement. La CLI l’utilise pour téléverser votre catalogue, et le serveur MCP pour s’authentifier. Gardez-la hors de tout code côté client.
Clé publiable (pk_…)
Réservée à la conversation et liée à l’origine, elle peut donc être intégrée sans risque dans le source de votre page — c’est exactement ce qu’utilise le widget de chat. Elle peut démarrer une conversation, rien de plus.
gak_<env>_<32 base32 chars>   # secret — CLI / MCP, server-side only
pk_<test|live>_<32 base32 chars>  # publishable — embedded in your page

Créer une clé

Les clés se gèrent sous Paramètres → Clés d’API dans le tableau de bord.

  1. Ouvrez Clés d’APIAllez dans Paramètres → Clés d’API et choisissez l’environnement pour lequel vous créez une clé.
  2. Choisissez le typeCréez une clé secrète pour la CLI ou MCP, ou une clé publiable pour le widget. Donnez-lui un nom que vous reconnaîtrez plus tard.
  3. Copiez-la maintenantLa clé complète n’est affichée qu’une seule fois. Copiez-la et conservez-la en lieu sûr avant de fermer la boîte de dialogue.

Les clés sont par environnement

Chaque clé appartient à un environnement. Une clé de développement ne peut pas toucher aux données de production et inversement, ce qui sépare proprement votre trafic de test et votre trafic réel.

Révoquer une clé

Révoquez une clé depuis la même page et elle cesse de fonctionner immédiatement. Révoquez-la sans attendre si elle est exposée, puis créez-en une de remplacement. Révoquer une clé n’affecte jamais les autres.

Garder les clés en sécurité

  • Stockez les clés secrètes dans un gestionnaire de secrets ou une variable d’environnement — jamais dans le contrôle de version ni le code front-end.
  • Les clés publiables sont conçues pour le front-end — elles ne font que démarrer des conversations et sont liées aux origines que vous autorisez.
  • Faites tourner les clés régulièrement : créez la nouvelle, basculez vos outils dessus, puis révoquez l’ancienne.
  • La création et la révocation de chaque clé sont consignées dans le journal d’audit de votre espace de travail.

Étapes suivantes