-Posibles errores
Para realizar tu integración con éxito, es necesario prestar atención a algunos puntos importantes en la realización de la misma, que son los siguientes:
Error de servidor y sus posibles causas: El error de servidor generalmente es causado por una respuesta inválida de la API. Algunos problemas comunes son:
- Tu solicitud contiene campos incorrectos, por lo que la respuesta de la API no es válida.
- Tu solicitud devuelve un estado de error que no puede mostrarse como un JSON válido.
- La API deseada no está devolviendo una respuesta en formato JSON.
- Hacer clic en "Probar solicitud" con un campo personalizado en la URL.
Para verificar con claridad los posibles problemas relacionados con la respuesta de la API, puedes realizar una prueba de tu aplicación utilizando POSTMAN, que es una herramienta para probar y depurar integraciones API.
-Errores de mapeo
Para ejecutar un mapeo de respuesta exitoso, es necesario prestar atención a los tipos de campos que utilizarás en el mapeo. Para tener éxito, sigue las instrucciones:
1. Evita utilizar campos que no sean del tipo texto de manera incorrecta: Actualmente, en BotConversa contamos con 4 tipos de campos, que son:
Texto: Este campo acepta todo tipo de valor y formato, incluyendo caracteres especiales, números, textos, etc. Te recomendamos usarlo para garantizar un buen mapeo en tus solicitudes y evitar así divergencias en el formato de campos en tu mapeo.
Número: Este campo solo acepta números y puntuaciones como punto (.) y coma (,). Otros tipos de caracteres no son aceptados en este campo.
Fecha: Este campo solo acepta fechas en un formato específico que sería (dd.mm.YYYY).
Fecha y Hora: Este campo se utiliza solo para almacenar fechas y horas. Por lo tanto, como se mostró anteriormente, solo aceptará fechas en el formato (dd.mm.YYYY HH:MM:SS).
💡 Si la respuesta devuelta por la API no está en el formato aceptado por el campo, puede causar un fallo en el mapeo, resultando en el no envío de la respuesta.
Ejemplo: Mapear en un campo de tipo Fecha, una respuesta que venga como "30/08/2024".
Esto causará un error, ya que el campo de fecha de BotConversa no reconoce este tipo de formato como válido.
2. Asegúrate de que el mapeo del campo de respuesta sea correcto, siguiendo el camino de la respuesta.
Aquí queremos capturar la respuesta que la API nos ha devuelto, y se encuentra en la parte de "Content", que se localiza dentro del parámetro "Choices".
Siguiendo este camino, podemos hacer el mapeo de la siguiente manera:
choices[0].message.content
Utilizo los corchetes [] para mostrar a la API que quiero seleccionar el parámetro 0, que es donde se localiza el camino.
Uso los puntos ( . ) para decirle a mi API que deseo buscar un objeto, que sería el siguiente paso.
Con esto, puedo realizar el mapeo para que mi API pueda identificar dónde deseo buscar la respuesta.
💡 El "root" es solo una manera en que BotConversa muestra el inicio de la API. El root NO cuenta como mapeo, por lo que basta con ignorarlo.
En este caso, si deseamos buscar el código postal (CEP), basta con hacer el mapeo como:
cep
-Headers
Generalmente, algunos errores de APIs se encuentran en los encabezado de la solicitud que estamos intentando ejecutar. Algunos de ellos son
1. API PHP: Cuando se tiene una API que se está ejecutando en PHP, es necesario insertar una forma de mapeo en el encabezado. Envía la siguiente información en el encabezado del bloque de integración:
User-Agent:
Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36
Generalmente, esta información debe enviarse en casos donde el enlace de la solicitud esté en PHP.
2. Autenticación incorrecta: Algunas APIs, como la API de OpenAI, requieren que se inserte "Bearer" delante de la clave API.
💡 Te recomendamos siempre verificar en la documentación de la API que estás utilizando para insertar los Headers de manera correcta, y así lograr que la integración sea exitosa