Adjunta un flujo compartido con un hook de flujo

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X.
Información

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 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 el 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, los detalles se registrarán en Analytics 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 clásica de Edge.

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 la experiencia de New 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, conectar el flujo al entorno de Apigee Edge con 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 hooks de flujo solo está disponible para los administradores de una organización de Apigee Edge.

Para obtener más información sobre los flujos compartidos, consulta Flujos compartidos reutilizables.

Puedes adjuntar un flujo compartido a un hook de flujo mediante la consola de administración de Apigee Edge. Puedes adjuntar, como máximo, un flujo compartido a un hook de flujo en cada uno de los siguientes lugares:

  • Enlace de flujo previo al proxy para la lógica que se debe aplicar ANTES de que se ejecute un extremo del proxy.

    Por ejemplo, podrías tener una lógica para aplicar la seguridad en todas las API de un entorno.

  • Enganche de flujo previo al destino para la lógica que se debe aplicar ANTES de llamar a un objetivo.

    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.

  • Enlace de flujo posterior al destino para la lógica que se debe aplicar DESPUÉS de que se ejecute 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.

  • Enlace de flujo posterior al proxy para la lógica que se debe aplicar DESPUÉS del extremo del proxy y justo antes de que la respuesta se envíe 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.

  1. Accede a la página Hooks de flujo, como se describe a continuación.

    Conexión de integración

    Para acceder a la página Hooks de flujo mediante la IU de Edge, haz lo siguiente:

    1. Accede a apigee.com/edge.
    2. Selecciona la organización que contiene tu flujo compartido. Consulta Cómo cambiar entre tus organizaciones.

      El flujo compartido estará disponible para todos los proxies de API y los flujos compartidos implementados en un entorno desde esta organización. No estará disponible fuera de esta organización.

    3. Selecciona Administrador > Entornos > Hooks de flujo en la barra de navegación izquierda.

    Versión clásica de Edge (nube privada)

    Para acceder a la página Hooks de flujo mediante la IU de Edge clásica, haz lo siguiente:

    1. Accede a http://ms-ip:9000, donde ms-ip es la dirección IP o el nombre de DNS del nodo del servidor de administración.
    2. Selecciona la organización que contiene tu flujo compartido. Consulta Cómo cambiar entre tus organizaciones.

      El flujo compartido estará disponible para todos los proxies de API y los flujos compartidos implementados en un entorno desde esta organización. No estará disponible fuera de esta organización.

    3. En la barra de navegación superior, selecciona APIs > Configuración del entorno > Enganches de flujo.
  2. En la lista de hooks de flujo, identifica el hook de flujo al que deseas adjuntar el flujo compartido en función de dónde deseas que se ejecute el flujo compartido.
    Ubicación del hook de flujo Descripción
    Hook de flujo previo al proxy ANTES de que se ejecute un extremo del proxy
    Hook de flujo previo al destino ANTES de que se ejecute un extremo de destino
    Hook de flujo posterior al objetivo DESPUÉS de que se ejecute la respuesta objetivo
    Hook de flujo posterior al proxy LUEGO del extremo del proxy y justo antes de enviar la respuesta al cliente
  3. Coloca el cursor sobre el enlace de flujo en la lista para mostrar la columna de acciones.
  4. Haga clic en .
  5. En el diálogo de flujo compartido, selecciona el flujo compartido que deseas adjuntar en el menú desplegable Flujo compartido.
  6. Haz clic en OK.
  7. Vincula flujos compartidos a otros hooks de flujo según sea necesario.