Llamar a una API externa

Llama a una API de transferencia de estado representacional (REST) autenticada, gestiona la respuesta y extrae datos para los nodos de flujo de trabajo posteriores.

Lo que crearás: un flujo de trabajo que llama a una API de transferencia de estado representacional (REST) autenticada, gestiona la respuesta y pone los datos extraídos a disposición de los nodos posteriores. Este es uno de los patrones más comunes en Flow: se aplica a cualquier sistema que expone un punto final HTTP.

Qué necesitará

• A UiPath Automation Cloud account with access to Flow.
• La URL base de la API de destino, la ruta del punto final y los detalles de autenticación (clave de API, token al portador o credenciales de autenticación básicas).

Nodos utilizados

• Desencadenador manual : inicia el flujo de trabajo bajo demanda
• Solicitud HTTP : llama a la API REST
• Transform — extracts the fields you need from the response
• Script — returns the error details on the HTTP Request's error path

Pasos

1. Crea un nuevo flujo y añade un desencadenador

1. Open Maestro Orchestrate → Flow and create a new workflow.
2. Arrastra un Desencadenador manual al lienzo.

2. Añade y configura el nodo de solicitud HTTP

1. Arrastra un nodo Solicitud HTTP al lienzo y conéctalo al desencadenador.
2. En el panel de configuración:
   • Establece Método en el verbo adecuado (GET, POST, PUT, PATCH o DELETE).
   • Introduce la URL completa del punto final.
   • En Encabezados, añade encabezados de autenticación y de tipo de contenido.

Para la autenticación de clave API:

Añade un encabezado con la clave Authorization y el valor Bearer {{ secret.apiKey }}. El prefijo secret. le dice a Flow que busque el valor en tu almacén de variables seguro; nunca pegues la clave directamente en el campo.

Para la autenticación básica:

Añade un encabezado con la clave Authorization y el valor Basic {{ secret.encodedCredentials }}, donde encodedCredentials es la cadena username:password codificada en base64.

3. Extrae los datos que necesitas

1. Arrastra un nodo Transformación de datos al lienzo y conéctalo al nodo de solicitud HTTP.
2. En el panel de configuración, asigna los campos de respuesta que necesitas de $vars.httpRequest1.output.body a variables de salida con nombre.

Por ejemplo, para extraer el nombre y el correo electrónico de un usuario de una respuesta como { "user": { "name": "Alex", "email": "[e-mail]" } }, asigna:

• $vars.httpRequest1.output.body.user.name → userName
• $vars.httpRequest1.output.body.user.email → userEmail

4. Añadir gestión de errores

1. Selecciona el nodo Solicitud HTTP, abre la pestaña Gestión de errores y activa Habilitar gestión de errores. Aparece un Controlador de error debajo del controlador de salida principal.
2. Selecciona el + en el manipulador de Error , busca Script y selecciónalo.
3. In the Script node, return the error details from $vars.httpRequest1.error. The returned message appears in the execution trace:

const error = $vars.httpRequest1.error;
return {
  message: "Error raised: " + error.message,
  status: error.status
};

5. Probar y depurar

Selecciona Prueba. En el seguimiento de ejecución:

• Comprueba la salida statusCode del nodo de solicitud HTTP. 200 significa éxito; 401 significa que tu autenticación es incorrecta; 404 significa que la URL es incorrecta.
• Comprueba la salida del nodo Transformación de datos para confirmar que los campos se han extraído correctamente.
• Para probar la ruta de error, establece temporalmente la URL en un valor no válido y verifica que la ruta de error se ejecute.

Resultado

Your workflow calls the REST API, extracts the fields you need from the response, and returns the error details on the error path. You can inspect the HTTP status code and extracted values in the execution trace, and confirm both the success and error paths work as expected.

Ampliar este flujo de trabajo

• Manejar la paginación: si la API devuelve resultados en varias páginas, añade nodos de solicitud HTTP de seguimiento para obtener páginas adicionales, ramificándose con una decisión sobre si la respuesta incluye un cursor de página siguiente.
• Escribir resultados en otro sistema: después del nodo Transformación de datos, añade otro nodo de solicitud HTTP o un nodo de integración para enviar los datos en sentido descendente.
• Programarlo: reemplaza el Desencadenador manual por un Desencadenador programado para ejecutar el flujo de trabajo en un intervalo regular.