Llamar a una API externa

Build a workflow step by step that calls an API with HTTP Request, then reshapes the response with Transform and Script.

Lo que creas

Un flujo de trabajo que llama a una API REST (Representational State Transfer) autenticada, gestiona la respuesta y pone los datos extraídos a disposición de los nodos posteriores. Una API REST es un servicio web al que otro software puede llamar a través de HTTP. El patrón se aplica a cualquier sistema que exponga una API HTTP.

Antes de comenzar

• 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.
• Transformar: extrae los campos necesarios de la respuesta.
• Script: registra fallos en la ruta de error de la solicitud HTTP.

Pasos

Consejo:

Con una configuración de agente de codificación, puedes omitir los pasos manuales. Pregúntelo:

Build a Maestro Automate workflow that starts manually with a userId, calls GET https://dummyjson.com/users/{userId} with an HTTP Request node, returns the user's name and email, and logs the error on the node's error path if the call fails.

A continuación, abre el flujo de trabajo en el lienzo, compruébalo con los siguientes pasos y pruébalo. Configurar tu agente de codificación describe la configuración.

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

Crea un proyecto, como se describe en Tu primer flujo de trabajo . El lienzo se abre con un desencadenador manual ya en él.

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

1. Selecciona el + en el manipulador de salida del Desencadenador manual, busca Solicitud HTTP y selecciónala.
2. En el panel de propiedades:
   • 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 token al portador:

Añade un encabezado con la clave Authorization y el valor Bearer {{ secret.apiKey }}. El prefijo secret. lee el valor del almacén de variables seguras. La clave nunca se pega 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. Selecciona el + en el manipulador de salida del nodo Solicitud HTTP, busca Transformación de datos y selecciónalo.
2. En el panel de propiedades, 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. En el nodo Script, registra el error de $vars.httpRequest1.error:

const error = $vars.httpRequest1.error;
console.log('API call failed:', error.message, '| Status:', error.status);
return null;

5. Probar y depurar

Select Run Debug (▶) in the bottom toolbar of the canvas. In the execution trace:

• Comprueba la salida code 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

El flujo de trabajo llama a la API REST, extrae los campos de la respuesta y registra los fallos en la ruta de error. El seguimiento de ejecución muestra el código de estado HTTP y los valores extraídos para ambas rutas.

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.

Próximos pasos

• Implementar un flujo de trabajo: hace que el flujo de trabajo se ejecute sin ti.
• Guías: más flujos de trabajo para crear.
• Comunidad: comparte lo que creaste o pide ayuda a otros creadores.