En este tutorial se explica cómo usar el asistente de proxy de Apigee para crear un proxy con un destino de integración. El proxy utiliza una referencia de activación de API de una integración para iniciar la secuencia de pasos de la integración.
En los pasos que se indican a continuación se describe cómo configurar el proxy Integration target para que la integración se realice correctamente cuando se llame al proxy.
Antes de empezar
- Confirma tus credenciales de inicio de sesión de Apigee y los detalles de la organización. Esta información es necesaria para acceder a la función Integración de aplicaciones y al asistente de proxy en la interfaz de usuario de Apigee.
- Crea y publica una integración con un activador de API y al menos una tarea.
- Si aún no has creado una integración que use un activador de API, sigue los pasos que se indican en Recuperar la carga útil de la API y enviar un correo electrónico.
- Anota el nombre de la integración que crees o de la que ya tengas y quieras usar, ya que se utilizará 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 integración de aplicaciones
(roles/integrations.applicationIntegrationInvokerRole)
a la cuenta de servicio. Para obtener información sobre los roles predefinidos de Application Integration, consulta Roles de IAM predefinidos. - Permite que tu cuenta de usuario (principal) asigne cuentas de servicio a recursos con el permiso
iam.serviceAccounts.actAs
. Para obtener información sobre los permisos de las cuentas de servicio, consulta Roles para la autenticación de cuentas de servicio .
Debes proporcionar esta cuenta de servicio al implementar el proxy de API.
- Asigna el rol Invocador de integración de aplicaciones
- Si quieres usar Application Integrations sin limitaciones,
puedes pagar por las integraciones. La integración de aplicaciones está disponible como servicio complementario para tu suscripción. Si ya has comprado el derecho de Application Integration y quieres habilitarlo en tu proyecto de Google Cloud o en tu organización de Apigee, ponte en contacto con el equipo de Asistencia de Apigee. Sin embargo, si quieres comprar el derecho de integración de aplicaciones, ponte en contacto con el equipo de ventas de Apigee. Una vez que se haya habilitado Application Integration, realiza las siguientes tareas:
- Habilita las siguientes APIs:
- API de Apigee (apigee.googleapis.com)
- API Application Integration (integrations.googleapis.com)
- API Secret Manager (secretmanager.googleapis.com)
- API Connectors (connectors.googleapis.com)
Para obtener información sobre cómo habilitar las APIs, consulta Habilitar servicios.
- Habilita los complementos Integration y Connectors en tu organización de Apigee.
Si vas a crear una organización para usarla en la integración, 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 que ya tengas, 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 han habilitado correctamente con el siguiente comando:
curl -H "Authorization: Bearer $TOKEN" -H "content-type:application/json" "https://apigee.googleapis.com/v1/organizations/${ORG_ID}"
Al ejecutar el comando, debería aparecer un mensaje similar al siguiente:
{ "name": "Test....", "createdAt": "1615483867669", "lastModifiedAt": "1615483873468", …... "addonsConfig": { "integrationConfig": { "enabled": true, "connectorsPlatformConfig": { "enabled": true } } }
- Asigna los siguientes roles de gestión de identidades y accesos a tu cuenta de servicio predeterminada de Apigee(
service-PROJECT_NUMBER@gcp-sa-apigee.iam.gserviceaccount.com
):- Invocador de integración de aplicaciones (
roles/integrations.applicationIntegrationInvokerRole
)
Para obtener información sobre cómo conceder roles o permisos adicionales a una cuenta de servicio, consulta Conceder, cambiar y revocar el acceso.
- Invocador de integración de aplicaciones (
- Habilita las siguientes APIs:
Crear un proxy de destino de Application Integration
Para crear un proxy de destino de integración en la interfaz de usuario de Apigee, haz lo siguiente:
- Ve a la interfaz de usuario de Apigee e inicia sesión.
- Selecciona tu organización en el menú desplegable de la esquina superior izquierda de la interfaz de usuario.
- En la vista principal, haz clic en Proxies de API.
También puede seleccionar Desarrollar > Proxies de API en el menú de navegación de la izquierda.
- En la lista desplegable Entorno, selecciona el entorno en el que quieras crear un proxy de API.
- Haz clic en Crear.
- Seleccione Destino de la integración en la lista de tipos de proxy.
Se inicia el asistente para crear proxy.
- En la página de configuración Proxy details (Detalles del proxy), proporciona los siguientes datos:
- Nombre: introduce un nombre para el proxy.
Los nombres de proxy pueden contener caracteres alfanuméricos, guiones y guiones bajos.
- Ruta base: se rellena automáticamente en función del nombre del proxy.
La ruta base es parte de la URL que se usa para enviar solicitudes a tu API. Apigee usa la URL para asociar y enrutar las solicitudes entrantes al proxy de API adecuado.
- Descripción: (opcional) introduce una breve descripción del proxy.
Por ejemplo,
Proxy test for Application Integration
. - Región de integración: seleccione la región de la integración en la lista desplegable.
- Destino de la integración: selecciona el nombre del destino de la integración en la lista desplegable. Tenga en cuenta que la lista de destinos de integración se rellena en función de la región de integración seleccionada.
- Activador: selecciona el activador de API asociado a la integración en la lista desplegable.
- Tipo de endpoint: selecciona Sincronización.
- Nombre: introduce un nombre para el proxy.
- Haz clic en Siguiente.
- En la página de configuración Common policies (Políticas comunes), deja las selecciones predeterminadas y haz clic en Next (Siguiente).
- En la página Resumen, haz clic en Crear.
Se ha creado correctamente un proxy Integration target.
Implementar el proxy
Sigue estos pasos para implementar el proxy que acabas de crear:
- En la interfaz de usuario de Apigee, selecciona Desarrollo > Proxies de API.
La interfaz de usuario muestra una lista de proxies de API y su estado de implementación.
- En la lista desplegable Entorno, selecciona el entorno en el que quieras desplegar el proxy de API.
Haz clic en el proxy que has creado recientemente y que quieres implementar. La interfaz de usuario muestra la página Vista general de forma predeterminada.
- Para implementar los cambios, primero haz clic en Implementar para que se muestre el cuadro de diálogo Implementar.
- Introduce lo siguiente:
- Revisión: el número de revisión del proxy que quieres implementar.
- Entorno: el entorno en el que quieres desplegar el proxy.
- Cuenta de servicio: la cuenta de servicio creada para el proxy.
- Haz clic en Desplegar.
La interfaz de usuario inicia el proceso de implementación de la revisión seleccionada. El despliegue del proxy puede tardar hasta un minuto en completarse.
Cuando se implementa el proxy, en la columna Estado de la sección Implementaciones se muestra un icono verde para indicar que se ha implementado la revisión 1 del proxy.
Probar el proxy de destino de la integración
Ejecuta el siguiente comando desde la ventana de terminal para invocar el proxy y activar la integración:
curl -v https://YOUR_ENV_GROUP_HOSTNAME/PROXY_NAME
donde YOUR_ENV_GROUP_HOSTNAME
es el nombre de host de un grupo de entornos que contiene el entorno en el que se ha desplegado tu proxy.
Por ejemplo:
curl -v https://my-org-prod.hybrid.e2e.apigeeks.net/my-proxy
Para confirmar que la integración se ha activado al invocar el proxy, sigue estos pasos:
- Abre la interfaz de usuario de Apigee.
- Haz clic en Desarrollo > Integraciones.
- Busca o selecciona el nombre de la integración creada en los pasos anteriores y haz clic en él.
- Haz clic en Registros.
- Verifica que exista un registro de ejecución de la integración activada. Para ver los detalles del registro, haz clic en la fila para desplegar los detalles de la ejecución.
Actualizar la carga útil de la solicitud de proxy (opcional)
Sigue estos pasos para actualizar la carga útil de la solicitud de proxy:
- En la interfaz de usuario de Apigee, selecciona Desarrollo > Proxies de API en el menú de navegación de la izquierda.
- Haz clic en el proxy que acabas de crear.
De forma predeterminada, la interfaz de usuario muestra la pestaña Vista general de ese proxy en el editor de proxies.
- Haz clic en la pestaña Desarrollar.
- En el panel Navegador, seleccione Set Integration Request (Definir solicitud de integración) en el encabezado Policies (Políticas).
- Quita las marcas de comentario del bloque
<Parameters>
e introduce los detalles de los parámetros.Para especificar parámetros concretos, utilice el elemento
<Parameter>
. Para especificar matrices de parámetros, usa el elemento<ParameterArray>
. - Haz clic en Guardar.
Siguientes pasos
Consulta el diseño de los diseñadores de integraciones y familiarízate con los distintos conceptos de integración que se describen en Todos los conceptos.