❓ ¿Para qué sirve el bloque de Integraciones?
El Bloque de Integración de BotConversa se utiliza para realizar SOLICITUDES a APIs externas dentro de su propio flujo en BotConversa.
De manera práctica, toda integración que se realice dentro del propio flujo de conversación podrá utilizar el bloque de integración, ya que durante la ejecución del flujo realiza la solicitud y devuelve los datos para la continuación del flujo. (Ejemplo: durante el flujo, preguntar el código postal del contacto, realizar una consulta en una API y devolver el nombre de la calle del contacto)
❓ ¿Cuáles son los métodos de integración existentes?
En una integración API, se utilizan URLs HTTP, es decir, a través de estos enlaces se pueden enviar datos, así como recibir datos. Para ello, existen los métodos presentes dentro del bloque de integración, que deben ser seleccionados de acuerdo con la documentación API del software que se desea integrar. Estos métodos son:
GET: Recibir algún dato externo dentro de BotConversa.
POST: Enviar datos desde BotConversa a otros softwares vía API.
PUT: Utilizado para actualizar alguna información de forma completa.
PATCH: Utilizado para actualizar alguna información de forma parcial.
DELETE: Método dedicado para eliminar información o configuraciones.
Recuerda que, para realizar cualquier integración y saber qué método usar, debes tener en mano la documentación API de la herramienta que deseas integrar con BotConversa.
❓ ¿Cuál es la estructura del bloque de integraciones?
- Headers:
Este es un campo muy importante, ya que es en este campo donde se utilizarán parámetros, claves de autenticación y se podrá informar el agente del usuario. Es importante destacar que el uso de este campo está directamente relacionado con la documentación API de un sistema, por lo que debes prestar atención a todos los detalles de lo que debe usarse en el Header de la Solicitud
- Body
Cuando necesitas enviar datos de un cliente (como desde un navegador web) a tu API, los envías como cuerpo (body) de la solicitud. El cuerpo de la solicitud es la información enviada por el cliente a tu API. Puedes enviar en el cuerpo de tu solicitud campos personalizados del usuario, del robot y también del sistema, como teléfonos, correos electrónicos, entre otros.
- Respuesta
El campo de respuesta es básicamente el retorno de tu solicitud API; a través de él recibirás un mensaje de éxito y también los datos de una solicitud GET, que podrás mapear posteriormente en la pestaña de Mapeo de Respuesta, como verás a continuación
- Mapeo de la Respuesta
Este campo del bloque de integración es uno de los más importantes, ya que en él se realizará el mapeo de tu solicitud dentro de BotConversa, pudiendo usar esta información en tus flujos. Básicamente, debes seleccionar qué índice deseas guardar de tu respuesta y luego seleccionar el campo personalizado en la compañía. En este ejemplo a continuación, estamos tomando la respuesta de "Barrio" de la solicitud API, y guardándola en el campo personalizado "Barrio" dentro de BotConversa
➕ Salidas del Bloque de Integración
En el bloque de integración de BotConversa, existen 2 salidas: la salida de ARRIBA es la de Respuesta con éxito. Es decir, la salida de arriba del bloque se ejecuta solo cuando la solicitud se realiza y tiene un retorno, mientras que la salida de abajo se ejecuta instantáneamente, continuando el flujo.
Importante: La salida de arriba tiene un tiempo de espera de 10 segundos; es decir, si el bloque de integración no obtiene un retorno en hasta 10 segundos, el flujo continuará sin la información.
