API

El bloque API te permite conectar tu flujo de trabajo a servicios externos a través de endpoints API utilizando peticiones HTTP. Admite varios métodos como GET, POST, PUT, DELETE y PATCH, permitiéndote interactuar con prácticamente cualquier endpoint API.

Descripción general

El bloque API te permite:

Cómo funciona

El bloque API procesa las peticiones HTTP a través de un enfoque estructurado:

1. Configurar petición - Establecer URL, método, cabeceras y parámetros del cuerpo
2. Ejecutar petición - Enviar petición HTTP al endpoint especificado
3. Procesar respuesta - Gestionar datos de respuesta, códigos de estado y cabeceras
4. Gestión de errores - Administrar tiempos de espera, reintentos y condiciones de error

Opciones de configuración

URL

La URL del endpoint para la petición API. Puede ser:

• Una URL estática introducida directamente en el bloque
• Una URL dinámica conectada desde la salida de otro bloque
• Una URL con parámetros de ruta

Método

Selecciona el método HTTP para tu petición:

• GET: Recuperar datos del servidor
• POST: Enviar datos al servidor para crear un recurso
• PUT: Actualizar un recurso existente en el servidor
• DELETE: Eliminar un recurso del servidor
• PATCH: Actualizar parcialmente un recurso existente

Parámetros de consulta

Define pares clave-valor que se añadirán a la URL como parámetros de consulta. Por ejemplo:

Key: apiKey
Value: your_api_key_here

Key: limit
Value: 10

Estos se añadirían a la URL como ?apiKey=your_api_key_here&limit=10.

Cabeceras

Configura las cabeceras HTTP para tu solicitud. Las cabeceras comunes incluyen:

Key: Content-Type
Value: application/json

Key: Authorization
Value: Bearer your_token_here

Cuerpo de la solicitud

Para métodos que admiten un cuerpo de solicitud (POST, PUT, PATCH), puedes definir los datos a enviar. El cuerpo puede ser:

• Datos JSON introducidos directamente en el bloque
• Datos conectados desde la salida de otro bloque
• Generados dinámicamente durante la ejecución del flujo de trabajo

Acceso a los resultados

Después de completar una solicitud API, puedes acceder a sus salidas:

• <api.data>: Los datos del cuerpo de respuesta de la API
• <api.status>: Código de estado HTTP (200, 404, 500, etc.)
• <api.headers>: Cabeceras de respuesta del servidor
• <api.error>: Detalles del error si la solicitud falló

Funciones avanzadas

Construcción dinámica de URL

Construye URLs dinámicamente usando variables de bloques anteriores:

// In a Function block before the API
const userId = <start.userId>;
const apiUrl = `https://api.example.com/users/${userId}/profile`;

Reintentos de solicitud

El bloque API gestiona automáticamente:

• Tiempos de espera de red con retroceso exponencial
• Respuestas de límite de velocidad (códigos de estado 429)
• Errores del servidor (códigos de estado 5xx) con lógica de reintento
• Fallos de conexión con intentos de reconexión

Validación de respuesta

Valida las respuestas de la API antes de procesarlas:

// In a Function block after the API
if (<api.status> === 200) {
  const data = <api.data>;
  // Process successful response
} else {
  // Handle error response
  console.error(`API Error: ${<api.status>}`);
}

Entradas y salidas

Ejemplos de casos de uso

Obtener datos de perfil de usuario

Procesamiento de pagos

Mejores prácticas

• Usa variables de entorno para datos sensibles: No codifiques directamente claves API o credenciales
• Maneja los errores con elegancia: Conecta lógica de manejo de errores para solicitudes fallidas
• Valida las respuestas: Comprueba los códigos de estado y formatos de respuesta antes de procesar datos
• Respeta los límites de tasa: Ten en cuenta los límites de tasa de la API e implementa la limitación apropiada