En este instructivo, se muestra cómo usar el asistente de proxy de Apigee para crear un proxy con un destino de integración. El proxy usa una referencia del activador de API de una integración existente para iniciar la secuencia de pasos de la integración.
En los siguientes pasos, se describe cómo configurar el proxy de destino de integración para ejecutar una integración exitosa cuando se llama al proxy.
Antes de comenzar
- Confirma tus credenciales de acceso de Apigee y los detalles de la organización. Esta información es necesaria para acceder a la función de Application Integration y al asistente de proxy dentro de la IU de Apigee.
- Crea y publica una integración con un activador de API y al menos una tarea.
- Si aún no creaste una integración que usa un activador de API, sigue los pasos que se indican en Recupera la carga útil de la API y envía un correo electrónico.
- Anota el nombre de la integración que creas o la integración existente que deseas usar, ya que la usarás en un paso posterior.
- Crea una cuenta de servicio de Google en el mismo proyecto de Google Cloud en el que se creó tu organización de Apigee y haz lo siguiente:
- Asigna el rol Invocador de Application Integration
(roles/integrations.applicationIntegrationInvokerRole)
a la cuenta de servicio. Para obtener información sobre los roles predefinidos de Application Integration, consulta Roles predefinidos de IAM. - Permite que tu cuenta de usuario (principal) adjunte cuentas de servicio a recursos con el permiso
iam.serviceAccounts.actAs
. Si deseas obtener información sobre los permisos de la cuenta de servicio, consulta Roles para la autenticación de la cuenta de servicio.
Debes proporcionar esta cuenta de servicio cuando implementes el proxy de API.
- Asigna el rol Invocador de Application Integration
- Si quieres usar Application Integration sin limitaciones, puedes pagar las integraciones. Application Integration está disponible como un servicio de complementos para tu suscripción. Si ya compraste el derecho de Application Integration y deseas habilitar el derecho para tu proyecto de Google Cloud o tu organización de Apigee, comunícate con la asistencia de Apigee. Sin embargo, si deseas adquirir el derecho de Application Integration, comunícate con Ventas de Apigee. Después de habilitar Application Integration, realiza las siguientes tareas:
- Habilita las siguientes APIs:
- API de Apigee (apigee.googleapis.com)
- API de Application Integration (integrations.googleapis.com)
- API de Secret Manager (secretmanager.googleapis.com)
- API de Connectors (connectors.googleapis.com)
Para obtener información sobre cómo habilitar las API, consulta Habilita servicios.
- Habilita los complementos de Integration y Connectors para tu organización de Apigee.
Si creas una nueva organización para usar con Integration, ejecuta el siguiente comando:
curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" -d '{"name":"${ORG_ID}", "analyticsRegion":"us-west1", "authorized_network":"${NETWORK_ID}", "runtimeType":"CLOUD", "runtimeDatabaseEncryptionKeyName":"${ENCRYPTION_KEY_NAME}", "addonsConfig": {"integrationConfig": {"enabled": true}, "connectorsPlatformConfig":{"enabled":true}}}' "https://apigee.googleapis.com/v1/organizations?parent=projects/${PROJECT_ID}"
Si usas una organización existente, ejecuta el siguiente comando:
curl -H "Authorization: Bearer $TOKEN" -H "content-type:application/json" "https://apigee.googleapis.com/v1/organizations/${ORG_ID}:setAddons" -XPOST -d '{"addonsConfig":{"integrationConfig":{"enabled":true},"connectorsPlatformConfig":{"enabled":true}}}'
- Verifica si los complementos se habilitaron de forma correcta con el siguiente comando:
curl -H "Authorization: Bearer $TOKEN" -H "content-type:application/json" "https://apigee.googleapis.com/v1/organizations/${ORG_ID}"
Cuando ejecutes el comando, debe aparecer un mensaje similar al siguiente:
{ "name": "Test....", "createdAt": "1615483867669", "lastModifiedAt": "1615483873468", …... "addonsConfig": { "integrationConfig": { "enabled": true, "connectorsPlatformConfig": { "enabled": true } } }
- Asigna los siguientes roles de IAM a tu cuenta de servicio de Apigee predeterminada (
service-PROJECT_NUMBER@gcp-sa-apigee.iam.gserviceaccount.com
):- Invocador de Application Integration (
roles/integrations.applicationIntegrationInvokerRole
)
Para obtener información sobre cómo otorgar roles o permisos adicionales a una cuenta de servicio, consulta Cómo otorgar, cambiar y revocar el acceso a los recursos.
- Invocador de Application Integration (
- Habilita las siguientes APIs:
Crea un proxy de destino de Application Integration
Haz lo siguiente para crear un proxy de destino de integración en la IU de Apigee:
- Ve a la IU de Apigee y accede.
- Selecciona tu organización mediante el menú desplegable que se encuentra en la esquina superior izquierda de la IU.
- Haz clic en Proxies de API en la vista principal.
Como alternativa, puedes seleccionar Develop > API Proxies en el menú de navegación de la izquierda.
- En la lista desplegable Entorno, selecciona el entorno en el que deseas crear un proxy de API nuevo.
- Haz clic en Crear nuevo.
- Haz clic en Integration target en la pantalla de tipos de proxy.
Se inicia el asistente de creación de proxy.
- En la página de configuración de detalles del proxy, proporciona los siguientes detalles:
- Nombre: Ingresa un nombre para la instancia.
Los nombres de proxy pueden contener caracteres alfanuméricos, guiones y guiones bajos.
- Ruta base: Se propaga de forma automática según el nombre del proxy.
La ruta base es parte de la URL que se usa para realizar solicitudes a la API. Apigee usa la URL para hacer coincidir solicitudes entrantes y enrutarlas al proxy de API adecuado.
- Descripción: Ingresa una descripción breve del proxy (opcional).
Por ejemplo,
Proxy test for Application Integration
. - Región de integración: Selecciona la región de la integración de la lista desplegable.
- Destino de integración: Selecciona el nombre de la integración en la lista desplegable. Ten en cuenta que la lista del destino de integración se propaga en función de la región de integración seleccionada.
- Activador: Selecciona el activador de la API asociado con la integración en la lista desplegable.
- Tipo de extremo: Selecciona Sincronizar.
- Nombre: Ingresa un nombre para la instancia.
- Haga clic en Next.
- En la página de configuración de Políticas comunes, deja las selecciones predeterminadas y haz clic en Siguiente.
- En la página Resumen, haz clic en Crear.
Se crea correctamente un proxy de destino de integración.
Implementa el proxy
Realiza los siguientes pasos para implementar el proxy recién creado:
- En la IU híbrida, selecciona Desarrollar > Proxies de API.
La IU muestra una lista de proxies de API y sus estados de implementación.
- En la lista desplegable Entorno, selecciona el entorno en el que deseas implementar el proxy de API.
Haz clic en el proxy creado recientemente que quieras implementar. La IU muestra la página Descripción general de forma predeterminada.
- Para implementar los cambios, primero haz clic en Implementar a fin de mostrar el cuadro de diálogo Implementar.
- Ingresa el siguiente comando:
- Revisión: Es el número de revisión del proxy que deseas implementar.
- Entorno: Es el entorno en el que deseas implementar el proxy.
- Cuenta de servicio: La cuenta de servicio creada para el proxy.
- Haz clic en Implementar.
En la IU comienza el proceso de implementación de la revisión seleccionada. La implementación del proxy puede tomar hasta un minuto en completarse.
Cuando el proxy está implementado, la columna Estado en la sección Implementaciones muestra un ícono verde para mostrar que se implementó la revisión 1 del proxy.
Prueba el proxy de destino de integración
Ejecuta el siguiente comando desde la ventana de la terminal para invocar el proxy y activar la integración:
curl -v https://YOUR_ENV_GROUP_HOSTNAME/PROXY_NAME
En el ejemplo anterior, YOUR_ENV_GROUP_HOSTNAME
es el nombre de host para un grupo de entornos que contiene el entorno en el que se implementa el proxy.
Por ejemplo:
curl -v https://my-org-prod.hybrid.e2e.apigeeks.net/my-proxy
Para confirmar que la integración se activó mediante la invocación del proxy, sigue estos pasos:
- Abre la IU de Apigee.
- Haz clic en Desarrollar > Integraciones.
- Busca o selecciona el nombre de la integración que creaste en los pasos anteriores y haz clic en el nombre de la integración.
- Haga clic en Registros.
- Verifica que exista un registro de ejecución para la integración activada. Si quieres ver los detalles del registro, haz clic en la fila para expandir los detalles de ejecución.
Actualiza la carga útil de la solicitud del proxy (opcional)
Usa los siguientes pasos para actualizar la carga útil de la solicitud de proxy:
- En la IU de Apigee, selecciona Develop > API Proxies en el menú de navegación de la izquierda.
- Haz clic en el proxy creado recientemente.
De forma predeterminada, la IU muestra la pestaña de descripción general de ese proxy en el editor de proxy.
- Haz clic en la pestaña Desarrollar:
- En el panel Navigator, selecciona Set Integration Request en el encabezado Policies.
- Quita los comentarios del bloque
<Parameters>
y, luego, ingresa los detalles del parámetro.Para especificar parámetros individuales, usa el elemento
<Parameter>
. Para especificar arrays de parámetros, usa el elemento<ParameterArray>
. - Haz clic en Guardar.
¿Qué sigue?
Explora el Diseño del diseñador de integración y comprenda los diversos conceptos de integración descritos en Todos los conceptos.