Llamada web externa

 

Dentro de SmartFlows, use el módulo de Llamada web externa para configurar una llamada web externa para enviar y recibir información. Una solicitud HTTP le permite interactuar con aplicaciones y códigos fuera de SmartFlows.

 

SmartFlows cifra la configuración de llamada web externa en reposo para mayor seguridad.

 

  1. Para editar los detalles de configuración, simplemente haga clic en el enlace «aquí» en ese mensaje. Su configuración se abrirá y le permitirá realizar cambios.

La próxima vez que haga clic en ‘Guardar’, las configuraciones se ocultarán y se volverán a cifrar.

Activadores de transición

La llamada web externa tiene dos eventos en el menú desplegable de acciones que activan transiciones.

 

  • Success: Se hizo una conexión.
  • Fail: La URL no se devuelve correctamente o tiene un error.

 

Variables de respuesta

Una vez que la llamada web externa devuelva un objeto JSON válido, seleccione sus datos y cree su variable.

Nota: Esta es la respuesta que alguien podría esperar si usara la notación de puntos (es decir, array[0].first_name) para acceder al contenido de un elemento en una serie.

[

   {

        “_id”: “5c86c534307bb30000jkjaa”,

       “first_name”: “John”,

        “last_name”: “Smith”,

        “pin”: 7777,

    }

]


Campos:

Encabezados

Utilice encabezados HTTP para transferir información adicional al extremo de la API junto con la solicitud.

 

  • Por lo general, se usan para agregar metadatos a la solicitud.
  • Los encabezados aceptados se basan en lo que está configurado en el extremo de la API y deben estar presentes en la documentación de la API.
  • Autorización/clave.

Nombre de usuario y contraseña

Estos campos admiten una autenticación básica en caso de que sea necesaria para acceder al extremo de la API.

 

  • La autenticación basada en tokens también puede admitirse agregando un encabezado personalizado a la solicitud.
 
Método

Indique la acción que debe realizar la URL según la configuración de la API.

 

SmartFlows admite estos métodos, pero dependen de la configuración específica de la API.

 

Nota: Actualmente, POST, GET y PUT están disponibles para admitir el envío y extracción de información, respectivamente. Se agregarán más métodos dentro de poco.

Tiempo de espera

Configure la duración del tiempo de espera en segundos en que SmartFlows debería esperar la respuesta de la API antes de que la solicitud falle.

 

  • El valor predeterminado es 10 segundos. La mayoría de las solicitudes serán retornadas en menos de un segundo.
  • Una mejor práctica es mantener todo en un período de tiempo corto para no consumir capacidad innecesariamente.
 
URL del servicio

Ingrese la URL del extremo de la API, aquí:

 

  • Se pueden usar las variables dentro de las URL para apuntar a objetos específicos.
 
Variables de respuesta

Extraer respuestas JSON/XML en variables con nombre.

 

  • 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 usuario ofrecen más granularidad y permiten al usuario extraer un subconjunto de la respuesta. Por ejemplo, si el usuario está interesado en extraer un valor llamado orderStatus de su API, puede agregar una variable de respuesta con dicho nombre a la acción de llamada web externa. El nombre debe coincidir literalmente con el nombre enviado por la API.

  • Luego, los datos extraídos se almacenan en una variable SmartFlows con el mismo nombre. Esta variable luego se puede invocar en partes posteriores del flujo utilizando la siguiente sintaxis: $EXTCALL_6.orderStatus

 

Esta variable también aparece en la sección Available Variables del panel de configuración de acciones en acciones posteriores. Allí, se puede usar en mensajes, texto a voz, análisis y otras llamadas web.

 
Variables

La acción de llamada web externa crea varias variables.

 

Cualquier clave en la API que coincida con una variable de respuesta con nombre en la acción de la llamada web permitirá que su valor correspondiente se almacene en la variable de respuesta.

 

  1. responsebod: La respuesta completa de la API externa.
  2. Statuscode: El código de respuesta generado desde la API (por ejemplo, 200 para success, 400 para bad request, 404 para not found, etc.)
Botón Test HTTP Request

Una vez que haya ingresado todas las configuraciones de llamadas web deseadas, puede probar su solicitud directamente en SmartFlows y previsualizar la respuesta utilizando el botón Test HTTP Request. Así es como luce con un ejemplo de configuración para un flujo que crea una tarjeta Trello cuando se recibe un mensaje de texto.

SmartFlows a continuación realizará una llamada de API a su servicio y mostrará la respuesta en una ventana.

 

Este es un ejemplo de la respuesta de Trello cuando la solicitud tiene éxito:

Este es un ejemplo de la respuesta de Trello si se envía un token incorrecto:

 

 

Esta función le ayudará a corregir errores en la configuración de su API y a poner en marcha sus integraciones más rápidamente.