Llamada web externa

La acción Externa Web Call le permite iniciar una solicitud HTTP o HTTPS a otro sistema. Se podría utilizar para postear nuevos registros en sus sistemas internos, buscar datos sobre un cliente en su base de datos, iniciar flujos de trabajo automatizados, ¡y más!

Encabezados

Los Headers HTTP se pueden usar para pasar información adicional al endpoint de la API junto con la solicitud y, por lo general, se usan para agregar metadatos a la solicitud. Los Headers aceptados se basan en lo que está configurado en el endpoint de la API y deberían estar presentes en la documentación de la API.

Nombre de usuario y contraseña

Estos campos admiten autenticaciones básicas cuando es necesario acceder al endpoint de la API. Las autenticaciones basadas en token también se pueden admitir agregando un Header personalizado a la solicitud.

Método

Este campo permite al usuario indicar qué acción debe realizar la API cuando se recibe la solicitud. Actualmente, POST y GET están disponibles para permitir el envío de información y la extracción de información, respectivamente. Más métodos se agregarán a esta lista en el futuro.

Límite de Tiempo

Con este campo, el usuario puede configurar la duración del tiempo (en segundos) que SmartFlows debe esperar para obtener respuesta de la API antes de que falle la solicitud. El valor predeterminado es 10 segundos. Una práctica recomendada es mantenerlo en una ventana de tiempo corta para evitar el consumo innecesario de capacidad. La mayoría de las solicitudes serán devueltas en menos de un segundo.

URL del Servicio

En este campo el usuario ingresará la URL del endpoint de la API. Se pueden usar variables dentro de las URL para apuntar a objetos específicos.

Tipo de Contenido

Este es otro ejemplo de un Header de uso muy común que se ha agregado a la interfaz de usuario para mayor facilidad de uso. Con este menú desplegable, el usuario puede seleccionar qué formato usar para que la solicitud sea compatible con su API.

Body (Cuerpo)

Este campo le permite al usuario ingresar al body una solicitud de POST que le gustaría enviar a su API. El Body debe comprender cualquier información necesaria para admitir la lógica de negocios deseada de la API, formateada según el tipo de contenido seleccionado.

Variables de Respuesta

Esta función es compatible con el formato de respuesta JSON y XML.

Cuando se envía una solicitud, la respuesta completa se recopila en una variable llamada “EXTCALL_6.responsebody”. Sin embargo, las variables de respuesta configuradas por el usuario ofrecen más granularidad y permiten al usuario extraer un subconjunto de la respuesta. Por ejemplo, si el usuario desea extraer un valor llamado “orderStatus” de su API, puede agregar una variable de respuesta con ese nombre a la acción externa web call (llamada web externa). El nombre debe  coincidir literal con el nombre enviado por la API.

Los datos extraídos se almacenan en una variable SmartFlows con el mismo nombre. Esta variable se puede invocar en partes posteriores del flujo, usando la siguiente sintaxis:

$EXTCALL_6.response.orderStatus

Esta variable también aparecerá en la sección Available Variables  (Variables Disponibles) del panel de configuración de acciones en acciones futuras, donde se puede usar en mensajes, texto a voz, análisis o incluso a otras llamadas web.

Variables

La acción external web call crean varias variables.

Responsebody
Toda la respuesta de la API externa.

Statuscode
Código de respuesta generado desde la API. (esto es, 200 para success, 400 para bad request, 404 para not found, etc.)

Variables de respuesta configuradas por el usuario

Cualquier clave en la API que coincida con una variable de respuesta nombrada en la acción web call permitirá que su valor correspondiente se almacene en la variable de respuesta. Consulte la sección anterior sobre las variables de respuesta para  más información.