Puedes hacer que los flujos compartidos realicen un procesamiento previo estándar de la solicitud o un procesamiento posterior de la respuesta en un conjunto de API. Con un hook de flujo, adjuntas un flujo compartido a fin de que se ejecute en el mismo lugar para todos los proxies de API implementados en un entorno específico. Esto te brinda una secuencia de lógica implementada por separado que no forma parte del código de implementación de un proxy.
Debido a que el código adjunto a un hook de flujo está fuera del contexto de la lógica principal del proxy de API, parte del comportamiento difiere de los proxies de API. Ten en cuenta lo siguiente:
Debes tener permiso para adjuntar un flujo compartido a un hook de flujo. Debes ser un administrador de la organización.
Solo puedes adjuntar un flujo compartido a cada hook de flujo.
Puedes conectar el mismo flujo compartido a varios hook de flujo.
Si un flujo compartido adjunto a un hook de flujo genera una falla o hay errores durante la ejecución del flujo compartido, el mensaje se rechazará y el error se enviará al emisor.
Si se rechaza un mensaje durante la ejecución de un hook de flujo, se registrarán los detalles en las estadísticas en el contexto del proxy llamado. El flujo compartido también puede arrojar una falla con un código personalizado y un mensaje de error.
En el siguiente video, se muestra cómo conectar un flujo compartido a un hook de flujo y, a continuación, realizar un seguimiento en la IU de Edge.
Un flujo compartido adjunto a un proxy a través de un hook de flujo proporciona un excelente lugar para la lógica que aplica requisitos de política amplios. Por ejemplo, imagina que tienes un equipo que administra un único conjunto de requisitos de seguridad para varios equipos que representan diferentes líneas de negocios (LOB). Cada equipo de LOB puede desarrollar API según sus propios requisitos y sin necesidad de tener en cuenta los requisitos de seguridad más amplios. El equipo de seguridad puede implementar esos requisitos de seguridad en un flujo compartido y, luego, adjuntar el flujo al entorno de Apigee mediante un hook de flujo. Debido a que el flujo compartido no forma parte del código de proxy, el equipo de seguridad puede revisarlo según sea necesario sin interferir en el código de LOB.
Los flujos compartidos adjuntos a través de hooks de flujo se ejecutan en esa posición para cada proxy de API implementado en el entorno del hook de proxy. Por esta razón, la capacidad de usar hook de flujo solo está disponible para los administradores de una organización de Apigee.
Adjunta un flujo compartido a un hook de flujo mediante la IU de Apigee o la API de Flowhooks. Puedes adjuntar, como máximo, un flujo compartido a un hook de flujo en cada uno de los siguientes lugares:
Hook de flujo previo al proxy para lógica que debe aplicarse ANTES de ejecutar un extremo del proxy.
Por ejemplo, podrías tener una lógica para aplicar la seguridad en todas las API de un entorno.
Hook de flujo previo al objetivo para lógica que debe aplicarse ANTES de ejecutar un extremo de destino.
Por ejemplo, puedes implementar el registro antes de que la solicitud llegue al backend. También puedes aplicar la mediación si quitas ciertos campos de la solicitud.
Hook de flujo posterior al objetivo para la lógica que se debe aplicar LUEGO de la ejecución de la respuesta objetivo.
Se aplicará de inmediato después de que la respuesta vuelva del backend. Puedes usarlo para registrar la respuesta del backend o realizar alguna mediación quitando los campos sensibles de la respuesta del backend.
Hook de flujo posterior al proxy para la lógica que debe aplicarse LUEGO del extremo proxy y justo antes de enviar la respuesta al cliente.
Esto podría incluir cierta lógica de aplicación para CORS, el registro de la respuesta o la realización de un mashup o formateo.
Conecta un flujo compartido a un hook de flujo
Para adjuntar un flujo compartido a un hook de flujo, debes ser administrador de la organización que contiene el flujo compartido.
Apigee en la consola de Cloud
Para agregar un flujo compartido a un hook de flujo, haz lo siguiente:
El flujo compartido estará disponible para cualquier proxy de API y flujos compartidos implementados en un entorno de esta organización. No estará disponible fuera de esta organización.
En el panel de navegación izquierdo, haz clic en Administración > Entornos.
Selecciona el entorno que deseas editar de la lista de entornos disponibles.
Haz clic en la pestaña Hook de flujo en la página Detalles del entorno.
La vista Hook de flujo se muestra.
En la lista de hooks de flujo, identifica el hook de flujo al que deseas adjuntar el flujo compartido.
El hook de flujo que elijas depende de dónde deseas que se ejecute el flujo compartido.
Ubicación del hook de flujo
Descripción
Enlace de flujo
Se ejecuta antes de que se ejecute un extremo del proxy.
Enlace de flujo anterior al destino
Se ejecuta antes de que se ejecute un extremo del destino.
Enlace de flujo posterior al destino
Se ejecuta después de que se ejecute la respuesta del destino.
Enlace de flujo posterior al proxy
Luego del extremo del proxy y justo antes de enviar la respuesta al cliente
En el cuadro de lista del hook de flujo que elegiste, selecciona el flujo compartido que deseas conectar.
Vincula flujos compartidos a otros hooks de flujo según sea necesario.
Haz clic en Guardar para adjuntar los flujos compartidos seleccionados a los hooks de flujo.
Apigee clásico
Para agregar un flujo compartido a un hook de flujo, haz lo siguiente:
El flujo compartido estará disponible para cualquier proxy de API y flujos compartidos implementados en un entorno de esta organización. No estará disponible fuera de esta organización.
Selecciona Administrador > Entornos > Hooks de flujo en la barra de navegación izquierda.
La vista Hook de flujo muestra lo siguiente:
En la lista desplegable del entorno, selecciona el entorno que deseas modificar.
En la lista de hooks de flujo, identifica el hook de flujo al que deseas adjuntar el flujo compartido.
El hook de flujo que elijas depende de dónde deseas que se ejecute el flujo compartido.
Ubicación del hook de flujo
Descripción
Enlace de flujo
Se ejecuta antes de que se ejecute un extremo del proxy.
Enlace de flujo anterior al destino
Se ejecuta antes de que se ejecute un extremo del destino.
Enlace de flujo posterior al proxy
Luego del extremo del proxy y justo antes de enviar la respuesta al cliente
Enlace de flujo posterior al destino
Se ejecuta después de que se ejecute la respuesta del destino.
Coloca el cursor sobre el hook de flujo en la lista para mostrar la columna de acciones.
Haz clic en createEditar.
En el cuadro de diálogo Shared Flow, selecciona el flujo compartido que deseas conectar en el menú Shared Flow.
Haz clic en Aceptar.
Vincula flujos compartidos a otros hooks de flujo según sea necesario.
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Información o código de muestra incorrectos","incorrectInformationOrSampleCode","thumb-down"],["Faltan la información o los ejemplos que necesito","missingTheInformationSamplesINeed","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 2025-08-28 (UTC)"],[[["\u003cp\u003eThis content explains how to use flow hooks in Apigee and Apigee hybrid to attach shared flows for pre-processing or post-processing across multiple APIs.\u003c/p\u003e\n"],["\u003cp\u003eFlow hooks allow administrators to attach a shared flow to execute at specific points (pre-proxy, pre-target, post-target, post-proxy) in every API proxy deployed to a given environment.\u003c/p\u003e\n"],["\u003cp\u003eAttaching a shared flow to a flow hook is done through the Apigee UI or Flowhooks API, and it requires organization administrator permissions.\u003c/p\u003e\n"],["\u003cp\u003eA shared flow attached to a flow hook executes outside the core API proxy logic, allowing for the centralized management of policies like security or logging that applies to multiple APIs.\u003c/p\u003e\n"],["\u003cp\u003eThe attached shared flows to flow hooks can throw faults with custom messages, if any error occurs during execution, and are logged in the context of the calling proxy.\u003c/p\u003e\n"]]],[],null,["# Attaching a shared flow using a flow hook\n\n*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\nYou can have shared flows perform boilerplate request pre-processing or response\npost-processing across a set of APIs. With a *flow hook*, you attach a shared flow so that\nit executes at the same place for all API proxies deployed to a specific environment. This gives\nyou a separately implemented and deployed sequence of logic that is not part of a proxy's\nimplementation code.\n| **Note:** Attaching a shared flow to a flow hook is an action that has a very broad effect. The attached shared flow will execute at the flow hook's point **for every proxy deployed to that environment**.\n\nBecause code attached to a flow hook is outside the context of the API proxy core logic, some\nof its behavior differs from API proxies. Keep the following in mind:\n\n- You must have permission to attach a shared flow to a flow hook. You must be an org admin.\n- You can attach only one shared flow to each flow hook.\n- You can attach the same shared flow to multiple flow hooks.\n- If a shared flow attached to a flow hook raises a fault or there are errors during shared flow execution, the message will be rejected and fault will be sent back to the caller.\n- If a message gets rejected during execution of a flow hook, details will be logged to analytics in the context of the called proxy. The shared flow can also throw a fault with a custom code and error message\n\n| **Note:** This video was recorded with a previous version of the Apigee UI; however, the concepts are still valid.\n\nThe following video demonstrates how to connect a shared flow to a flow hook, then trace it,\nin the Apigee UI.\n\nA shared flow attached to a proxy via a flow hook provides a great place for logic that\nenforces broad policy requirements. For example, imagine that you have one team managing a single\nset of security requirements for multiple teams that represent different lines of businesses\n(LOBs). Each LOB team can develop APIs according to their own requirements, and without needing\nto account for the broader security requirements. The security team can implement those security\nrequirements in a shared flow, then attach the flow to the Apigee environment using a flow\nhook. Because the shared flow isn't part of proxy code, the security team can revise it as needed\nwithout interfering with LOB code.\n\nShared flows attached via flow hooks execute at that position for **every API proxy deployed\nto the proxy hook's environment**. For this reason, the ability to use flow hooks is available\nonly to administrators of an Apigee organization.\n\nFor more about shared flows, see\n[Creating reusable shared flows](/apigee/docs/api-platform/fundamentals/shared-flows).\n\nYou attach a shared flow to a flow hook using the Apigee UI or [Flowhooks API](/apigee/docs/reference/apis/apigee/rest/v1/organizations.environments.flowhooks). You can\nattach at most one shared flow to a flow hook at each of the following places:\n\n- **Pre-proxy flow hook** for logic that needs to be enforced BEFORE a proxy endpoint\n executes.\n\n For example, you could have logic for enforcing security across all the APIs in an\n environment.\n- **Pre-target flow hook** for logic that needs to be enforced BEFORE a target endpoint\n executes.\n\n For example, you could implement logging before the request reaches the backend. You could\n also enforce mediation by removing certain fields from the request.\n-\n **Post-target flow hook** for logic that needs to be enforced AFTER the target response\n executes.\n\n This will be enforced right after the response comes back from the backend. You can use it\n to log the backend response or perform some mediation by removing sensitive fields from the\n backend response.\n- **Post-proxy flow hook** for logic that needs to be enforced AFTER the proxy endpoint and\n right before the response is sent out to the client.\n\n This could include some enforcement logic for CORS, logging the response, or performing\n some mashup or formatting.\n\n### Attaching a shared flow to a flow hook\n\nTo attach a shared flow to a flow hook, you must be an administrator in the organization\ncontaining the shared flow.\n**Note:** Attaching a shared flow to a flow hook is an action that has a very broad effect. The attached shared flow will execute at the flow hook's point **for every proxy deployed to that environment**. \n\n### Apigee in Cloud console\n\nTo attach a shared flow to a flow hook:\n\n1. In the Google Cloud console, go to the **Management \\\u003e Environments** page.\n\n [Go to Environments](https://console.cloud.google.com/apigee/environments)\n2. Select the organization containing your shared flow. See [Switching between your organizations](/apigee/docs/api-platform/get-started/switch-org).\n\n The shared flow will be available to any API proxies and shared flows deployed to an\n environment from this organization. It won't be available from outside this organization.\n3. Select the environment you wish to edit from the list of available environments.\n4. Click the **Flow hooks** tab on the **Environment details** page.\n\n The **Flow hooks** view displays.\n5. In the list of flow hooks, identify the flow hook to which you want to attach the shared flow. The flow hook you choose depends upon where you want the shared flow to be executed.\n\n6. In the list box of the flow hook you chose, select the shared flow that you want to attach.\n7. Attach shared flows to other flow hooks as needed.\n8. Click **Save** to attach the selected shared flows to the flow hooks.\n\n### Classic Apigee\n\nTo attach a shared flow to a flow hook:\n\n1. Sign in to [Apigee UI](https://apigee.google.com).\n2. Select the organization containing your shared flow. See [Switching between your organizations](/apigee/docs/api-platform/get-started/switch-org).\n\n The shared flow will be available to any API proxies and shared flows deployed to an\n environment from this organization. It won't be available from outside this organization.\n3. Select **Admin \\\u003e Environments \\\u003e Flow hooks** in the left navigation bar.\n\n The **Flow hooks** view displays:\n\n4. From the environment drop-down list, select the environment that you want to modify.\n5. In the list of flow hooks, identify the flow hook to which you want to attach the shared flow. The flow hook you choose depends upon where you want the shared flow to be executed.\n\n6. Position your cursor over the flow hook in the list to display the actions column.\n7. Click create **Edit**.\n8. In the **Shared Flow** dialog, select the shared flow that you want to attach in the **Shared flow** menu.\n9. Click **OK**.\n10. Attach shared flows to other flow hooks as needed."]]
