Guide d'intégration développeur
Aperçu développeur
WebChatAgent propose trois façons d'intégrer un chatbot pour vos utilisateurs. Choisissez celle qui correspond au niveau de contrôle souhaité sur l'interface.
| Intégration | Ce que vous obtenez | Idéal pour |
|---|---|---|
| Intégration du Widget | Une interface de chat prête à l'emploi via une simple balise de script | Sites web et applications web |
| REST API | Envoyez un message, recevez une réponse (requête/réponse) | Interfaces personnalisées, applications mobiles, scripts serveur |
| WebSocket API | Flux de messages en temps réel avec indicateurs de saisie et présence | Tableaux de bord de Chat en direct, outils pour agents |
| SDK JavaScript | Paquet npm typé pour la REST API et la WebSocket API | Interfaces de chat personnalisées en JavaScript ou TypeScript |
| Webhook | Nouveaux prospects et rendez-vous sous forme de requête JSON signée vers votre serveur | Synchronisation CRM, automatisations |
Ces solutions communiquent toutes avec le même chatbot, partagent la même Base de connaissances et sont décomptées du même quota de messages. Vous pouvez les combiner, par exemple en intégrant le widget sur votre site tout en créant un Tableau de bord d'agent interne basé sur la WebSocket API.
Intégration du Widget (le plus rapide)
Ajoutez le chatbot à n'importe quel site web à l'aide d'une seule balise de script et d'un élément HTML personnalisé (<web-chat-agent chatbot-id="...">). Aucun framework, aucune étape de compilation. L'ensemble des couleurs, des textes et des outils se configure dans le Tableau de bord et s'applique automatiquement. C'est l'option idéale pour 90 % des sites web.
- Guide d'intégration du Widget, Balise de script, élément personnalisé, ensemble des attributs HTML, CSS personnalisé, mode en ligne et utilisation sur une SPA
REST API
Si vous devez concevoir votre propre interface de chat, qu'il s'agisse d'une application mobile, d'un composant web sur mesure ou d'une automatisation backend, appelez directement le point de terminaison du chat. Vous envoyez un message accompagné de votre chatbotId et recevez une réponse générée par l'IA avec ses sources. Un ID de session renvoyé dans un en-tête de réponse garantit la continuité des conversations à plusieurs échanges.
- Référence REST API, Points de terminaison, authentification par Domaine, champs de requête/réponse, codes d'erreur et exemples de code en cURL, JavaScript, Python et PHP
SDK JavaScript
Vous développez une interface de chat personnalisée en JavaScript ou TypeScript ? Le paquet npm webchatagent encapsule la REST API et la WebSocket API : réponses en streaming, Téléchargement de fichiers, retours d'utilisateurs, formulaires de leads et Chat en direct avec votre équipe, le tout avec un typage complet en TypeScript et sans aucune dépendance.
- SDK JavaScript : installation, premier message, streaming, transfert à un agent humain. Paquet sur npm, code source sur GitHub
WebSocket API
Pour le Chat en direct, lorsque les messages doivent arriver instantanément et que vous souhaitez afficher des indicateurs de saisie, la présence en ligne ainsi que la traduction automatique. Le même socket alimente les widgets des visiteurs et le Tableau de bord de l'agent. Utilisez-le pour concevoir une console d'agent personnalisée ou pour piloter le Chat en direct depuis votre propre backend.
- Référence WebSocket API, Connexion, rôles, événements émis et reçus, et exemple fonctionnel de client
Lequel choisir ?
| Cas d'utilisation | Recommandé |
|---|---|
| Ajouter un chatbot à un site web | Intégration du Widget |
| Intégrer le chat directement dans la mise en page de votre site | Chat intégré (intégration du widget) |
| Interface de chat personnalisée en JavaScript ou TypeScript | SDK JavaScript |
| Interface de chat personnalisée ou application mobile | REST API |
| Automatisation de serveur à serveur (sans interface) | REST API |
| Tableau de bord de Chat en direct en temps réel pour agents humains | WebSocket API |
Consultez la page Cas d'utilisation pour découvrir des scénarios concrets rendus possibles par ces intégrations.
