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

Référence SDK

Chaque SDK Keyda — Android, iOS, React Native, Flutter, Ionic — implémente le même contrat simple. Si vous en avez utilisé un, vous les avez tous utilisés.

L'API

AppelerFonctionnalités
init / initializeStocke votre Client ID. Le valide et signale toute erreur de format de manière explicite.
showAffiche le chat par-dessus votre application.
dismissLe ferme.
isShowingS'il est présenté en ce moment.

Il n'y a délibérément rien d'autre. Pas d'API d'envoi de messages, pas de compteur de messages non lus, pas d'appel d'identité utilisateur — car rien de tout cela ne fonctionne encore de bout en bout, et une méthode qui ne fonctionne pas est pire qu'une méthode manquante.

L'URL que chaque SDK ouvre

{baseUrl}/chat/{clientId}

baseUrl utilise https://keyda.in/business par défaut et peut être remplacé sur chaque plateforme, pour la préproduction ou une installation auto-hébergée.

Pourquoi une vue web, et ce que cela vous coûte

Il existe une interface de chat unique, fournie par la plateforme, et chargée sur chaque support.

Ce que vous obtenez : une modification effectuée par le propriétaire dans le tableau de bord — couleur d'accentuation, message de bienvenue, nom du bot, mise en ligne — atteint chaque application immédiatement, sans nouvelle version. Un correctif est déployé partout en une fois. Le chat est identique sur toutes les plateformes.

Ce que cela coûte : le chat nécessite une connexion. Il n'y a pas de mode hors ligne, et il n'y a pas encore de notifications push.

Nous préférons que vous le sachiez avant le déploiement plutôt que de le découvrir après.

Garanties offertes par chaque SDK

  1. Échappées de navigation. Un lien vers une autre origine s'ouvre dans le navigateur système au lieu de remplacer le chat. Sans cela, un simple clic sur un lien de pied de page met fin à la conversation du client sans possibilité de retour.
  2. Continuité des conversations. Le stockage DOM est activé : si un client ferme l'application et revient, il retrouve son fil de discussion là où il l'avait laissé (pendant 24 heures).
  3. Le clavier ne recouvre jamais la zone de saisie.
  4. Les zones de sécurité sont respectées — aucun chat n'est affiché sous une encoche ou un indicateur d'accueil.
  5. Aucun plantage n'atteint votre application. Un échec de chargement affiche une option de réessai.
  6. Aucune analyse, aucun identifiant d'appareil, aucune dépendance tierce. L'ajout d'un SDK Keyda n'ajoute aucun traceur à votre application.

Format de l'identifiant client

kb_live_ followed by 8-48 hexadecimal characters

Tout le reste est rejeté lors de l'initialisation plutôt que d'afficher une erreur 404 devant un client. Le Client ID est public par conception — il est visible sur tout site web intégrant le widget — et ne permet ni de lire ni de modifier votre compte. Voir limites et sécurité.

Source

Public, sous licence MIT : github.com/KeydaAI/keyda-business-sdks. Le contrat partagé auquel chaque package est soumis se trouve dans CONTRACT.md en haut de ce dépôt.

Next: Limits and security →