Keyda Business
FranceEnglish Connexion Commencer gratuitement
Documentation Keyda BusinessRéférence

API du widget

Pour les développeurs, ou toute personne souhaitant que le chat s'ouvre depuis son propre bouton.

Installation

<script src="https://keyda.in/business/widget.js"
        data-key="kb_live_your_key_here" async></script>

The script tag needs only src and data-key. Everything else — colours, position, greeting, language — comes from your dashboard so you never have to redeploy your site to change them.

The widget is drawn in the language set on Install → Language your bot speaks: its button, placeholders and notices, and the direction of the layout (Arabic and Urdu are right-to-left). The strings arrive with the widget's configuration, so there is no second request and nothing to translate on your side.

Modes

Flottant (par défaut). Un bouton de lancement dans le coin, ouvrant un panneau de discussion.

Intégré. Placez un conteneur vide sur la page et le chat s'y affichera à la place :

<div data-keyda-bot style="height:520px"></div>

Le conteneur a besoin d'une hauteur. En mode intégré, le chat est toujours visible, il n'y a donc rien à ouvrir ou à fermer.

API JavaScript

Disponible sur window.KeydaBot une fois le script chargé :

AppelerFonctionnalités
KeydaBot.open()Ouvre le panneau de chat
KeydaBot.close()Le ferme
KeydaBot.toggle()Ouvre ou ferme
KeydaBot.expand()Rend le panneau aussi haut que la fenêtre et jusqu'à 760px de large
KeydaBot.shrink()Retour à la carte standard
KeydaBot.isOpentrue quand le chat est visible
KeydaBot.isExpandedtrue pendant que le panneau est déployé
KeydaBot.clientIdL'identifiant client utilisé par cette page

Exemple — ouvrez le chat depuis votre propre bouton « Discutez avec nous » :

<button onclick="KeydaBot.open()">Chat with us</button>
Le script se charge de manière asynchrone, donc window.KeydaBot peut ne pas exister immédiatement après le chargement de la page. Attachez les gestionnaires à un clic plutôt que de les appeler pendant l'analyse de la page.

Comment il se comporte sur votre page

  • Le panneau s'ouvre au-dessus du bouton de lancement, qui reste à sa place et devient la commande de fermeture. Appuyer à nouveau dessus, sur la croix ✕ dans l'en-tête, ou appuyer sur Échap ferme le chat.
  • Un visiteur peut agrandir le panneau depuis l'en-tête — il s'étend à la hauteur de la fenêtre jusqu'à 760px de large — et ce choix est mémorisé dans son navigateur. Sur mobile, le panneau occupe déjà tout l'écran, cette option n'est donc pas affichée.
  • Your logo size setting changes the logo, not the button: the launcher keeps its size and the logo grows inside it. Button size (Install → Appearance) is what resizes the button itself — small, medium or large — whatever shape it is.
  • Four button shapes: a pill with your label, a round bubble, a rounded square, and a chat bubble with a tail. The tail sits on the side facing your page.
  • Tout est rendu à l'intérieur d'un shadow root, ainsi votre CSS ne peut pas casser le widget et le CSS du widget ne peut pas affecter votre site.
  • Le panneau ne se charge que lorsqu'un visiteur l'ouvre, il ne ralentit donc pas votre page.
  • La conversation d'un visiteur se poursuit pendant 24 heures s'il revient, puis elle repart de zéro.
  • Si l'assistant est injoignable, le widget affiche un court message et ne provoque jamais d'erreur sur votre page.
Next: App SDKs →