Introducción

El componente “Rest api v2” permite integrar sus flujos con servicios o sistemas externos mediante solicitudes HTTP (por ejemplo, enviar o recibir datos desde CRMs, ERPs, plataformas de pago, o servicios en la nube).

Este componente permite consumir APIs de manera directa dentro de los flujos creados en los diferentes tipos de routing points o dentro de Agent Scripting.

Cada vez que el flujo llegue a este componente, se ejecutará automáticamente la solicitud configurada (GET, POST, PUT, DELETE o PATCH) y se guardará la respuesta en una variable que podrá usarse en los siguientes pasos del flujo.

Configuración

1. Desde el panel de componentes, arrastra el componente Rest api v2 al lienzo de trabajo y suéltalo en la posición deseada del flujo.
2. En la pestaña “Configuración”, completa los campos según el tipo de API que desees consumir.
3. Los campos son los siguientes: 
   • URL: Escribe la dirección del servicio al que deseas conectarte.
   • Método: Selecciona el tipo de petición que se realizará:
     • GET: Consulta datos.
     • POST: Envía o crea registros.
     • PUT: Actualiza información existente.
     • ELIMINA: Elimina registros (equivalente a DELETE).
     • PATCH: Actualiza parcialmente un registro.
   • Headers: Permite agregar cabeceras HTTP personalizadas (por ejemplo, Authorization, Content-Type, etc.). 
     • Usa el botón “Agregar” para añadir nuevas líneas de encabezados.
     • Borra líneas de encabezados dando clic derecho sobre la cabecera y seleccionando la opción “Borrar item”.
   • Cuerpo (Body): Selecciona el formato que usarás para enviar la información.
     • form-data.
     • raw (ideal para enviar JSON u otros formatos estructurados).
     • Escribe el contenido del cuerpo en el campo de texto grande.
   • Time out (Segs): Define el tiempo máximo en segundos que el sistema esperará la respuesta de la API antes de finalizar la solicitud.
   • Resultado: Escribe el nombre de la variable donde se guardará el response de la API. Ejemplo: $res_api_cliente.
   • Variables por defecto: El componente genera automáticamente dos variables.
     • $rest_api_time: Tiempo total de ejecución de la solicitud.
     • $rest_api_code: Código de estado HTTP devuelto por la API (por ejemplo, 200, 404, 500).
   • Haz clic en “Guardar” para aplicar los cambios.

1. Una vez completada la configuración, puedes verificar que tu conexión funciona correctamente:
2. Dirígete a la pestaña “Probar api”.
3. Presiona el botón “Probar api” para ejecutar la solicitud con los parámetros definidos. El resultado o response aparecerá en el panel principal de esta pestaña.
   • Esta función te permite validar el endpoint y ajustar cabeceras, cuerpo o formato antes de compilar el flujo completo.