Respuesta
El bloque de Respuesta es el paso final en tu flujo de trabajo que formatea y envía una respuesta estructurada a las llamadas API. Es como la declaración "return" para todo tu flujo de trabajo—empaqueta los resultados y los envía de vuelta.
Los bloques de respuesta son bloques terminales - finalizan la ejecución del flujo de trabajo y no pueden conectarse a otros bloques.
Descripción general
El bloque de Respuesta te permite:
Formatear respuestas API: Estructurar los resultados del flujo de trabajo en respuestas HTTP adecuadas
Establecer códigos de estado: Configurar códigos de estado HTTP apropiados según los resultados del flujo de trabajo
Controlar encabezados: Añadir encabezados personalizados para respuestas API y webhooks
Transformar datos: Convertir variables del flujo de trabajo en formatos de respuesta amigables para el cliente
Cómo funciona
El bloque de Respuesta finaliza la ejecución del flujo de trabajo:
- Recopilar datos - Reúne variables y salidas de bloques anteriores
- Formatear respuesta - Estructura los datos según tu configuración
- Establecer detalles HTTP - Aplica códigos de estado y encabezados
- Enviar respuesta - Devuelve la respuesta formateada al solicitante de la API
Cuándo necesitas bloques de respuesta
- Endpoints API: Cuando tu flujo de trabajo es llamado vía API, los bloques de Respuesta formatean los datos de retorno
- Webhooks: Devuelven confirmación o datos al sistema que realiza la llamada
- Pruebas: Ver resultados formateados al probar tu flujo de trabajo
Dos formas de construir respuestas
Modo constructor (recomendado)
Interfaz visual para construir la estructura de respuesta:
- Arrastrar y soltar campos
- Referenciar variables de flujo de trabajo fácilmente
- Vista previa visual de la estructura de respuesta
Modo editor (avanzado)
Escribir JSON directamente:
- Control total sobre el formato de respuesta
- Soporte para estructuras anidadas complejas
- Usar sintaxis
<variable.name>para valores dinámicos
Opciones de configuración
Datos de respuesta
Los datos de respuesta son el contenido principal que se enviará de vuelta al solicitante de la API. Deben estar formateados como JSON y pueden incluir:
- Valores estáticos
- Referencias dinámicas a variables de flujo de trabajo usando la sintaxis
<variable.name> - Objetos y matrices anidados
- Cualquier estructura JSON válida
Código de estado
Establece el código de estado HTTP para la respuesta. Los códigos de estado comunes incluyen:
- 200: OK - Respuesta estándar de éxito
- 201: Creado - Recurso creado con éxito
- 204: Sin contenido - Éxito sin cuerpo de respuesta
- 400: Solicitud incorrecta - Parámetros de solicitud inválidos
- 401: No autorizado - Se requiere autenticación
- 404: No encontrado - El recurso no existe
- 422: Entidad no procesable - Errores de validación
- 500: Error interno del servidor - Error del lado del servidor
- 502: Puerta de enlace incorrecta - Error de servicio externo
- 503: Servicio no disponible - Servicio temporalmente inactivo
El código de estado predeterminado es 200 si no se especifica.
Cabeceras de respuesta
Configura cabeceras HTTP adicionales para incluir en la respuesta.
Los encabezados se configuran como pares clave-valor:
| Clave | Valor |
|---|---|
| Content-Type | application/json |
| Cache-Control | no-cache |
| X-API-Version | 1.0 |
Ejemplos de casos de uso
Respuesta del punto final de la API
Escenario: Devolver datos estructurados desde una API de búsqueda
- El flujo de trabajo procesa la consulta de búsqueda y recupera resultados
- El bloque de función formatea y pagina los resultados
- El bloque de respuesta devuelve JSON con datos, paginación y metadatos
- El cliente recibe una respuesta estructurada con estado 200
Confirmación de webhook
Escenario: Confirmar recepción y procesamiento del webhook
- El disparador de webhook recibe datos del sistema externo
- El flujo de trabajo procesa los datos entrantes
- El bloque de respuesta devuelve una confirmación con el estado del procesamiento
- El sistema externo recibe la confirmación
Manejo de respuestas de error
Escenario: Devolver respuestas de error apropiadas
- El bloque de condición detecta fallos de validación o errores del sistema
- El enrutador dirige hacia la ruta de manejo de errores
- El bloque de respuesta devuelve estado 400/500 con detalles del error
- El cliente recibe información estructurada del error
Entradas y salidas
Datos de respuesta: Estructura JSON para el cuerpo de la respuesta
Código de estado: Código de estado HTTP (predeterminado: 200)
Encabezados: Encabezados HTTP personalizados como pares clave-valor
Modo: Modo Constructor o Editor para la construcción de respuestas
response.data: El cuerpo de respuesta estructurado
response.status: Código de estado HTTP enviado
response.headers: Encabezados incluidos en la respuesta
response.success: Booleano que indica finalización exitosa
Respuesta HTTP: Respuesta completa enviada al solicitante de la API
Terminación del flujo de trabajo: Finaliza la ejecución del flujo de trabajo
Acceso: Los bloques de respuesta son terminales - no hay bloques subsiguientes
Referencias de variables
Utiliza la sintaxis <variable.name> para insertar dinámicamente variables del flujo de trabajo en tu respuesta:
{
"user": {
"id": "<variable.userId>",
"name": "<variable.userName>",
"email": "<variable.userEmail>"
},
"query": "<variable.searchQuery>",
"results": "<variable.searchResults>",
"totalFound": "<variable.resultCount>",
"processingTime": "<variable.executionTime>ms"
}Los nombres de variables distinguen entre mayúsculas y minúsculas y deben coincidir exactamente con las variables disponibles en tu flujo de trabajo.
Mejores prácticas
- Usa códigos de estado significativos: Elige códigos de estado HTTP apropiados que reflejen con precisión el resultado del flujo de trabajo
- Estructura tus respuestas de manera consistente: Mantén una estructura JSON consistente en todos tus endpoints de API para una mejor experiencia del desarrollador
- Incluye metadatos relevantes: Añade marcas de tiempo e información de versión para ayudar con la depuración y el monitoreo
- Maneja los errores con elegancia: Utiliza lógica condicional en tu flujo de trabajo para establecer respuestas de error apropiadas con mensajes descriptivos
- Valida las referencias de variables: Asegúrate de que todas las variables referenciadas existan y contengan los tipos de datos esperados antes de que se ejecute el bloque de Respuesta