Aperçu
Un aperçu de l'API Assistant et de l'intégration du widget embarquable.
Qu'est-ce que c'est ?
La plateforme Assistant fournit une API pour construire des assistants conversationnels et un widget embarquable qui peut être placé sur des sites web. L'architecture typique sépare le code serveur porteur de secrets du code navigateur en émettant des jetons de widget à courte durée.
The Companin Widget is more than just a chat interface—it's a complete conversational AI platform that seamlessly integrates into your website. Built with modern web technologies (Next.js, React, TypeScript), it provides enterprise-grade reliability while maintaining simplicity for developers.
Unlike traditional chat widgets that require complex backend setup, Companin handles all the infrastructure for you. Authentication, message storage, conversation management, and AI processing are all managed through our secure API, allowing you to focus on creating great user experiences.
Concepts Principaux
Understanding these core concepts will help you make the most of the Companin Widget:
- Assistant : un agent conversationnel configuré.
- Session : un contexte temporaire pour un visiteur interagissant avec un assistant.
- Jeton de widget : JWT à courte durée pour authentifier les widgets dans les navigateurs.
- Auth : JWT ou en-têtes de paire clé API (X-API-Key + X-API-Secret).
💡 Key Insight
The widget configuration acts as the single source of truth for all appearance and behavior settings. This means you can update your widget's look and feel without changing any code on your website—just update the configuration in your dashboard and changes take effect immediately.
Comment ça marche (haut niveau)
- Le serveur détient le secret client et échange avec un jeton de widget à courte durée via /api/auth/widget-token.
- Le navigateur reçoit le jeton et initialise le widget ; le widget utilise le jeton pour appeler les points de terminaison API.
- Les points de terminaison côté serveur acceptent JWT ou paires d'en-têtes de clé API et appliquent des limites de débit au niveau de l'organisation.
Prochaines étapes
Suivez le Démarrage Rapide pour embarquer le widget, puis consultez la Référence API pour les détails.