ChakraHQChakraHQ

Nodo de API de llamada del chatbot

Pasos para usar el nodo de API de llamada en el chatbot

Usar el nodo API en el creador de chatbots

Puedes usar Call API para llamar a una API directamente desde el chatbot. También puedes usar la respuesta de la API en el flujo del chatbot.

Configuración del nodo API

  • API: puedes seleccionar o configurar los detalles de la API desde la sección API
  • Haz clic en "Show Editor" para actualizar la configuración de la API
  • Si usas una carga útil JSON, puedes escribir {{ para ver una lista de sustituciones de variables disponibles
  • Tendrás acceso al texto del último mensaje del chat y a los datos recopilados mediante el chatbot API Editor
  • ¿Guardar respuesta en una variable? Proporciona un nombre de variable para guardar en ella la respuesta de la API
  • ¿Ruta JSON del valor que se guardará? Proporciona una ruta JSON para extraer un valor específico de la respuesta JSON y guardarlo en la variable
  1. Se accede a la respuesta de la API con la clave response.data
  2. Así que, si la respuesta de tu API es { "value": "this is the response" }
  3. entonces la ruta JSON debería ser response.data.value

Call API Node Configuration

Configurar la salida de la API

La API puede dar como resultado un success (2xx response) o un failure (non 2xx response). Puedes vincular las opciones a otros nodos según corresponda.

Call API Node output

Guía de configuración del nodo API

A continuación, encontrarás una guía paso a paso para crear un nuevo chatbot con Call API Node

Crear un nodo API en el chatbot

  1. Crea un chatbot usando Message Node, Question Node, guarda la respuesta del chatbot con Upsert Node y conecta los nodos en un flujo
  2. Arrastra y suelta el nodo Call API a la derecha del nodo de pregunta
  3. Edita el Call Api Node
  4. Haz clic en Show Editor junto a la API seleccionada
  5. Realiza los cambios necesarios, como proporcionar la URL de la API y seleccionar el método HTTP
  6. Elige form url encoded o form multipart como tipo de cuerpo
  7. Haz clic en Add Another debajo de la sección key value
  8. Se creará una nueva entrada. En el campo de clave, proporciona un nombre, como text; en el campo de valor, selecciona la variable de consulta
  9. Haz clic en Save API para cerrar el editor
  10. En Store response in variable , agrega un nombre de variable, como api_response
  11. En JSON path of value to store , agrega una ruta JSON para seleccionar un valor específico de la respuesta de la API y guardarlo
    1. Se accede a la respuesta de la API con la clave response.data
    2. Así que, si la respuesta de tu API es { "value": "this is the response" }
    3. entonces la ruta JSON debería ser response.data.value
  12. Haz clic en Save para cerrar el editor del nodo API

Agregar un nodo de mensaje para la respuesta de la API

  1. Arrastra y suelta un nodo de mensaje a la derecha del nodo API
  2. Conecta la opción Success del nodo API con el nuevo nodo de mensaje
  3. Edita el nodo de mensaje
  4. Escribe un mensaje para el nodo de mensaje. Si quieres acceder a los datos que devuelve el nodo API, escribe @ y comienza a escribir para ver un menú con las variables disponibles. Elige la variable api\_response
  5. Haz clic en Save en el nodo de mensaje. Luego, haz clic en Save en la esquina superior derecha para guardar el chatbot.

Este chatbot le hará una pregunta al usuario y luego enviará la respuesta del usuario a la API que configuraste. Si se recibe una respuesta de la API, se le enviará al usuario.

Guide

En esta página