El pasoHacer llamada de APIpermite configurar una llamada de API a otro sistema, como un sistema CRM o ERP interno, o enviar los detalles de la conversación a un extremo externo, como Amazon Event Bridge o Google Analytics.
En este artículo se describen los procedimientos para incluir y configurar el paso en un flujo de bot.
Si desea información general sobre el pasoHacer llamada de APIy sus reglas de configuración, consulteComprender los tipos de pasos del bot: Hacer llamada de API.
Este artículo contiene las siguientes secciones:
Agregar un paso Hacer llamada de API al bot
Para agregar el pasoHacer llamada de APIal bot hay que realizar varias tareas específicas.
En los siguientes procedimientos se supone que ya se hacreado un flujo de boty se está agregando este paso a ese bot.
Para agregar un paso Hacer llamada de API
- Abra el bot en el generador de flujos.
- Haga clic en el iconoAgregar nuevodonde desea insertar el paso, ya sea al final de una rama o entre dos pasos existentes.
- En el panel Configuración, haga clic enHacer llamada de API.
- Ingrese información descriptiva para el paso. Solo será visible para su equipo; los clientes no verán la información que se ingrese aquí:
- Nombre: un nombre para la llamada que ayude al equipo a identificarla.
- Descripción(opcional): una descripción corta de la acción realizada por la llamada.
- Continúe con el procedimiento que se describe enAgregar detalles de la API, a continuación.
Agregar detalles de la API
Utilice la sección Detalles de la API para configurar la llamada HTTP que desea hacer, incluyendo el método de solicitud HTTP y la ubicación del recurso externo, y agregando encabezados si es necesario. Los pasos siguientes son una continuación del procedimiento que se describe en la sección anterior.
Para agregar los detalles de la API
- En el panel Configuración, haga clic enDetalles de la API.
- Utilice el menú desplegable para seleccionar unMétodo de solicitud:
- GETrecupera datos de un servidor en el recurso externo. Este es el método más usado.
- POSTenvía datos para crear o actualizar un recurso en un sistema externo. Si el recurso ya existe, los datos enviados modifican el recurso.
- PUTenvía datos para actualizar o crear un recurso. Si el recurso ya existe, los datos enviados reemplazan al recurso.
- PATCHenvía datos para actualizar un recurso en un sitio externo. Se usa para aplicar modificaciones parciales al recurso.
- DELETEelimina el recurso en la ubicación externa.
- Ingrese unURL de extremo. El URL de extremo es la ubicación del recurso externo con el cual desea conectarse. El URL admite el protocolo
https://
. Lasvariablesse pueden agregar a la ruta de URL o a los valores de la cadena de consulta. Si desea más información, consultePasar variables en una llamada de API. - Opcionalmente, seleccione una conexión para autenticar la llamada de API.Nota:Primero debecrear una conexiónpara poder usarla en el pasoHacer llamada de API.
- De ser necesario ingrese la劈开y el英勇对位un encabezado opcional.Importante:No use encabezados para autenticar. En lugar de ello, useconexiones de API.
Los pasosHacer llamada de APIque incluyan encabezados relacionados con una autenticación, como
authorization
ox-api-key
, fallarán de inmediato. Si un pasoHacer llamada de APIfalla, la conversación sigue la ramaError de llamada de API. - Para probar la llamada de API, haga clic enHacer llamada de API. Si se agreganvariablesal URL o encabezado del paso, se pueden incluir datos de prueba opcionales en el servicio externo para comprobar si la llamada de API está funcionando como se espera. Tenga en cuenta que esto hará una solicitud de HTTP al URL de extremo configurado.
Pasar variables en una llamada de API
Si se ingresa unURL de extremopara una llamada de API, se pueden incluirvariablesen la ruta del URL o los valores de la cadena de consulta. De esta manera se pueden pasar datos de la conversación al sistema externo.
Por ejemplo, un bot de mensajería puede solicitarle al cliente que proporcione el número de su pedido mediante un pasoSolicitar detallesy luego usar el pasoHacer llamada de APIpara averiguar el estado de envío de ese pedido de la tienda en línea.
Las variables no se pueden usar en el dominio ni el subdominio de un URL de extremo. La siguiente tabla presenta ejemplos de valores deURL de extremoválidos y no válidos.
URL de extremo válido | URL de extremo no válido |
---|---|
https://myshopify.com/admin/api/orders/order_number.json Recuperar un pedido especificando la ID del pedido de Shopify. ![]() |
Las variables no se pueden agregar al dominio/subdominio |
Recuperar una ubicación en función de búsquedas de palabras clave de la API de lugares de Google. |
Las variables no se pueden agregar a la clave de la cadena de consulta |
如果una变量没有es有效霉素o esta vacia el机器人la omite durante la conversación.
Guardar variables de la respuesta de la API
Después de configurar los detalles y comprobar la llamada de API, se pueden guardar los valores de la respuesta JSON de la llamada de API comovariables. Se pueden guardar hasta ocho variables en un pasoHacer llamada de API.
Para crear una variable a partir de los datos de Respuesta
- En el panel Configuración, haga clic enHacer llamada de API.
- Amplíe el acordeón e identifique los datos del sistema externo que desea convertir en una variable.Sugerencia:Cambie a la pestaña Cuerpo de respuesta para ver la respuesta sin procesar devuelta por el sistema externo.
- Haga clic enGuardar.
- Dele un nombre a la nueva variable. Los nombres de variables solo pueden incluir letras minúsculas, números y caracteres de subrayado.
Acerca de las ramas del paso
El pasoHacer llamada de APIes un paso de rama. Si se agrega este paso, las respuestas del bot se dividen según si la API se ejecutó correctamente.
Cuando se ejecuta el bot, 200 códigos de respuesta harán que el bot se desplace por la rama que se ejecutó correctamente. Todos los 400 o 500 códigos de respuesta harán que el bot se desplace por la rama que falló. Si la API devolvió 200 con una respuesta vacía, las variables que se guarden de este paso se omitirán durante una conversación.
0 Comentarios
Inicie sesiónpara dejar un comentario.