API de ExpertoBot
Bienvenido a la documentación de la API de ExpertoBot. Esta sección contiene toda la información necesaria para integrar y controlar el widget de ExpertoBot en tu aplicación web.
¿Qué es la API de ExpertoBot?
La API de ExpertoBot (window.EBot o simplemente EBot) es una interfaz JavaScript pública que te permite controlar el widget del chat de forma programática.
// Bootstrap del api (necesario)
window.EBot = window.EBot || function (...args) {
window.EBot.q = window.EBot.q || [];
window.EBot.q.push(args);
};
// Ejemplos
EBot('onReady', function() {
// Se abre el bot cuando abre la página
EBot('open');
});
Con esta API puedes:
- Abrir y cerrar el chat desde tu aplicación
- Verificar el estado del widget
- Crear launchers personalizados
- Escuchar cambios de estado y cuando el widget está listo
- Configurar el comportamiento del widget
Instalación
Para comenzar a usar la API de ExpertoBot, primero debes tener el widget instalado en tu sitio web. Si aún no lo has hecho, consulta nuestra guía de integración para obtener instrucciones detalladas.
Código de inicialización
Para usar la API de ExpertoBot, incluye este código antes de usar cualquier comando:
<script src="https://ebotscript.com/statics/v2/snippet.js?key=xxxx"></script>
<script>
// Código de inicialización
window.EBot = window.EBot || function (...args) {
window.EBot.q = window.EBot.q || [];
window.EBot.q.push(args);
};
</script>
Una vez instalado, puedes acceder a la API a través de la función global EBot().
Ejemplo Básico
// Esperar a que el widget esté listo
EBot('onReady', function() {
console.log('Widget listo para usar');
// Abre el chatbot...
EBot('open');
});
Comandos Disponibles
La API proporciona los siguientes comandos:
| Comando | Parámetros | Retorna | Descripción |
|---|---|---|---|
open | - | - | Abre el chat |
close | - | - | Cierra el chat |
toggle | - | - | Alterna entre abrir/cerrar |
isOpen | - | boolean | ¿Chat abierto? |
isReady | - | boolean | ¿Widget listo? |
onReady | callback | function | Escucha cuando está listo |
onStateChange | callback | function (state) | Escucha cambios de estado |
configs | {key: value} | - | Establece configuraciones |
Secciones
En las siguientes páginas encontrarás información detallada sobre:
- Funciones: Comandos para controlar el widget (open, close, toggle, etc.)
- Eventos: Cómo escuchar y reaccionar a cambios en el widget
- Configuración: Opciones para personalizar el comportamiento del widget