Crear un conector API
El conector API es parte de los orquestadores de workfloo (entre los que también se encuentran los formularios y los árboles de decisión). Su función es permitirte hacer llamadas API externas, pero al interior de workfloo.
Con conector API puedes incluir tanto servicios externos como APIs de link, el hub de kiban.
Dentro de tu workfloo, ubícate en el sitio en el que quieres añadir el conector API. Haz clic en dicho nodo (éstos tienen el signo + encerrado en un círculo). Al hacer clic se te pregunta si deseas añadir un nuevo paso o uno existente. Haz clic en la primera opción.
Se muestra un modal con diversos conectores que puedes integrar. Haz clic en API y después en siguiente.
Se muestra una pantalla para configurar tu conector API. Incluye un nombre.
Método y URL
Una vez que le asignes un nombre a tu conector, selecciona un método. Las opciones son:
GET
POST
PUT
PATCH
DELETE
Una vez que elegiste un método, ingresa la URL de la API a consumir en el espacio que se encuentra a la derecha de la lista desplegable.
Headers
Debes incluir los headers que integrarás a la petición en dos columnas: una con el nombre y otra con el valor. Ambos campos son obligatorios. Para eliminar un header, coloca el cursor sobre el nombre y valor registrado y haz clic en el icono del bote de basura.
Query parameters
Al igual que en los headers, debes incluir los query parameters en dos columnas: una con el nombre y otra con el valor. Ambos campos también son obligatorios. Si quieres eliminar algún query parameter, coloca el cursor sobre el nombre y valor registrado y haz clic en el icono del bote de basura.
Body
En la pestaña body se muestra un panel en el que puedes incluir el body, en caso de que sea necesario para enviar el request.
Los valores que se enviarán en la API se pueden reemplazar con los datos de un formulario o de variables calculadas con el conector variables.
Ejemplo:
Para hacer los reemplazos de una variable se coloca la cadena reservada {{VARIABLE:NOMBRE_VARIABLE}}. En NOMBRE_VARIABLE se coloca el nombre de la variable que se va a reemplazar.
Para hacer los reemplazos de un campo de formulario se coloca la cadena reservada {{FORM:API_ID}} donde API_ID será el identificador del campo del formulario que se reemplazará.
Importante:
Para saber cuál es el ID de un campo del formulario, ve a la configuración del formulario:
Para saber cuál es el ID de una variable, ve a la configuración del conector variable:
Salida de error
Una vez que añadas y guardes tu información, en tu workfloo se incluye el icono del conector API junto con una rama de error.
Una vez agregado el conector, tienes las siguientes posibilidades:
- Cuando termine la ejecución de tu conector, terminar el flujo de tu workfloo.
- Seguir con el flujo en la rama inferior (la rama de ejecución exitosa).
- Definir un flujo alternativo si ocurrió un error en tu conector (salida de error).
Si haces clic en el signo + rojo se te ofrecen dos opciones: elegir un nuevo paso o uno existente, es decir, añadir un nuevo conector, o bien, hacer un enlace a alguno que ya se encuentre dentro de tu workfloo.
Si decides no determinar algún camino para seguir con el flujo, éste se terminará en cuanto se presente el error.
Si, por algún motivo, decides borrar el conector API en el que determinaste una salida de error, se te muestra un modal de confirmación en el que se te advierte que todos los nodos relacionados con dicho conector en la rama de salida también serán eliminados. Si estás de acuerdo con ello, haz clic en guardar.