Keyda Business
MexicoEnglish Iniciar sesión Empezar gratis
Documentación de Keyda BusinessReferencia

Referencia del SDK

Todos los SDK de Keyda (Android, iOS, React Native, Flutter, Ionic) implementan el mismo contrato pequeño. Si ha usado uno, los ha usado todos.

La API

LlamarLo que hace
init / initializeAlmacena tu client id. Lo valida y falla de forma evidente si tiene un formato incorrecto.
showMuestra el chat sobre tu aplicación.
dismissLo cierra.
isShowingYa sea que se presente en este momento.

Deliberadamente no hay nada más. Ninguna API de envío de mensajes, ningún contador de no leídos, ninguna llamada de identidad de usuario, porque nada de eso funciona de extremo a extremo todavía, y un método que no funciona es peor que uno que falta.

La URL que abre cada SDK

{baseUrl}/chat/{clientId}

baseUrl tiene por defecto https://keyda.in/business y se puede anular en cualquier plataforma, ya sea para pruebas o para una instalación autohospedada.

Por qué usar una vista web y qué te cuesta

Hay una interfaz de chat, servida por la plataforma, y cada superficie la carga.

Lo que obtienes: un cambio que el propietario hace en el panel —color de acento, mensaje de bienvenida, nombre del bot, activación— llega a todas las aplicaciones de inmediato, sin necesidad de una nueva versión. Una corrección se aplica en todas partes a la vez. El chat es idéntico en todas las plataformas.

Lo que cuesta: el chat necesita una conexión. No hay modo sin conexión ni notificaciones push por ahora.

Preferimos que sepas esto antes de lanzar el producto en lugar de descubrirlo después.

Garantías que ofrece cada SDK

  1. Salidas de navegación. Un enlace a cualquier otro origen se abre en el navegador del sistema en lugar de reemplazar el chat. Sin esto, un solo toque en un enlace del pie de página termina la conversación de un cliente sin posibilidad de volver.
  2. Continuidad de la conversación. El almacenamiento DOM está activo, por lo que un cliente que cierra la app y regresa encuentra su hilo donde lo dejó (durante 24 horas).
  3. El teclado nunca cubre el campo de entrada.
  4. Se respetan las áreas seguras — no se dibuja ningún chat debajo de una muesca o indicador de inicio.
  5. Ningún fallo llega a tu aplicación. Si se produce un error de carga, se muestra la opción de reintentar.
  6. Sin analíticas, sin identificadores de dispositivos, sin dependencias de terceros. Añadir un SDK de Keyda no añade ningún rastreador a tu aplicación.

Formato de Client ID

kb_live_ followed by 8-48 hexadecimal characters

Cualquier otra cosa se rechaza al iniciar en lugar de abrir un 404 frente a un cliente. El Client ID es público por diseño —es visible en cualquier sitio web que incruste el widget— y no tiene la capacidad de leer ni modificar tu cuenta. Consulta límites y seguridad.

Fuente

Público, con licencia MIT: github.com/KeydaAI/keyda-business-sdks. El contrato compartido que cumple cada paquete está en CONTRACT.md en la parte superior de ese repositorio.

Next: Limits and security →