Saltar al contenido principal

Custom API

Usa Custom API cuando quieras que un paso del flujo de trabajo llame a un endpoint HTTP externo desde Fetch Hive y pase la respuesta a pasos posteriores.

Configuración

OpciónRequeridoDescripción
NameNoEtiqueta del paso en el lienzo del flujo de trabajo.
API MethodMétodo HTTP en API Method. Los valores disponibles son get y post.
API URLURL en API URL. Este campo admite variables del flujo de trabajo mediante Insert Variable.
HeadersNoCadena JSON ingresada en Headers.
BodyNoCadena JSON ingresada en Body. Este campo solo se muestra cuando API Method es POST.
Retry CountNoNúmero de reintentos en Retry Count.
When the step failsNoControla si el flujo de trabajo debe Terminate Workflow o Continue si este paso falla.
Agrega este paso desde el grupo Utilities en Search steps…. En el selector de pasos, la etiqueta es Call an API.
El panel de configuración tiene campos separados para API URL, Headers y Body. Cada campo puede incluir valores de Inputs o de Workflow Steps anteriores con Insert Variable.

Salida

Haz clic en Run en el encabezado del paso para probar la solicitud. Fetch Hive muestra la respuesta en Output después de que se complete la ejecución. Usa el selector de variables en un paso posterior para insertar la ruta exacta de respuesta disponible para esa ejecución. La referencia base es:
{{STEP_IDENTIFIER.output}}
Si solo necesitas el payload completo de la respuesta, referencia directamente la salida base:
{{step_2.output}}
Si la respuesta es un objeto estructurado, el selector de variables muestra los campos anidados que puedes insertar en pasos posteriores.

Ejemplo

Agrega Call an API desde el grupo Utilities en Search steps…. Establece Name en algo como Fetch customer profile. Elige GET o POST en API Method. Ingresa el endpoint en API URL. Si el endpoint necesita datos de pasos anteriores, haz clic en Insert Variable y agrega valores como {{step_1.output.customer_id}}. Si la solicitud necesita encabezados de autenticación o de contenido, agrégalos en Headers como JSON. Si usas POST, agrega el payload de la solicitud en Body. Ajusta Retry Count y elige qué debe pasar en When the step fails. Haz clic en Run y revisa la respuesta de la API en Output antes de conectar esa salida a pasos posteriores.

Notas

  • La etiqueta del selector de pasos es Call an API, aunque esta página y archivo usan Custom API.
  • La vista de solo lectura del despliegue muestra la URL, el método, el conteo de reintentos y el comportamiento ante fallos. No muestra ahí el resumen completo de encabezados ni del cuerpo de la solicitud.
  • Usa JSON válido en Headers y Body si tu API downstream espera payloads JSON.
Consulta también: Creación y edición, Pruebas e iteración y Manejo de errores