¿Cómo podemos ayudarte? 👋

Cómo utilizar solicitud de api externa en un flujo?

Utilizar solicitud de api externa en un flujo

La Solicitud Externa (External Request) te permite integrar tu bot con cualquier sistema que tenga una API. Puedes usar las Solicitudes Externas para obtener datos de cualquier otro sistema y mostrarlos al usuario dentro de tu chatbot.


¿Cómo usar External Request?

En el constructor de flujos (flow builder), agrega Actions > External API Request.

 
Notion image
 
 

Se muestra un ejemplo de un paso configurado.

Notion image
 

En este caso se utiliza una autenticación por medio del header.

Notion image
 

En el Body del request se coloca el código.

Notion image
 

Se mapea una variable en “Response Mapping”. Y con esto se completa la configuración del HTTP REQUEST para este ejemplo.

Notion image
 

Existen dos formas de mostrar al usuario los datos que devuelve una API dentro de tu bot:

  1. Guardar los datos en un Campo Personalizado usando Response Mapping, y luego usar ese campo dentro de tu flujo para mostrarlos al usuario.
  1. Hacer que tu API devuelva mensajes listos para mostrar al usuario (Dynamic Contents).
    1. Estos permiten que la API envíe directamente mensajes que el bot mostrará al usuario.

      Los contenidos dinámicos se explican más adelante en este artículo.


¿Cómo obtener el código de estado HTTP o el cuerpo completo de la respuesta?

En la sección Response Mapping:

  • Usa http_status_code para obtener el código de estado HTTP de la API.
  • Usa http_response_body para obtener todo el cuerpo de la respuesta en bruto.

Una vez que guardes el código de estado HTTP en un Campo Personalizado, puedes usar condiciones para crear cualquier lógica que necesites (por ejemplo, manejar éxito o error).


Descargar archivos devueltos por la API

Para descargar un archivo, utiliza http_download_EXTENSION.

Ejemplos:

  • Para descargar un archivo de audio MP3, usa:
    • http_download_mp3

  • Para descargar un archivo PDF, usa:
    • http_download_pdf

  • Para descargar una imagen, puedes usar:
    • http_download_png, http_download_jpg, etc.

 

Acá se muestran los diferentes tipo de request que se pueden configurar.

Notion image
 

Contenido Dinámico

El Contenido Dinámico te permite generar contenido desde tu propio servidor y mostrarlo al usuario dentro de tu Chatbot.

Este tipo de contenido es compatible con todos los canales, y se utiliza un formato único que funciona en cada uno de ellos.

La plataforma convierte automáticamente tu mensaje en tiempo real y lo envía al usuario en el formato adecuado.


Importante

No puedes usar la función de Contenido Dinámico si no eres el propietario de la API desde la cual obtienes los datos.

En ese caso, debes:

  1. Guardar los datos de la API en un Campo Personalizado usando Response Mapping, y
  1. Mostrar esos datos usando el Campo Personalizado dentro del constructor de flujos (flow builder).
Did this answer your question?
😞
😐
🤩