You're viewing Apigee Edge documentation.
Go to the
Apigee X documentation. info
What is Apigee Edge API Hub connector integration?
Apigee Edge API Hub connector integration facilitates the automatic onboarding of API metadata (such as API proxy definitions, specifications, and related details) and runtime data (like API traffic metrics and analytics) from your Apigee Edge organizations directly into Google Cloud's API Hub. This integration provides a centralized, unified view of your APIs across different gateways, simplifying API discovery, governance, and management.
Key benefits
- Centralized API discovery: All your Apigee Edge APIs are discoverable in API Hub alongside APIs from other sources.
- Enhanced visibility: Gain insights into your API landscape with consolidated metadata and runtime information.
- Streamlined management: Simplify API governance and lifecycle management across your diverse API ecosystem.
How it works
The Apigee Edge API Hub connector integration establishes a secure and automated channel for your API information to flow from your Apigee Edge organizations to API Hub. This process involves a handshake between Apigee Edge and the API Hub provisioning service.
- API Hub provisioning & plugin instance: You begin by setting up API Hub within your Google Cloud project and creating a Plugin Instance. This Plugin Instance acts as a unique identifier (Gateway ID) and a registration point for your Apigee Edge organizations. During this setup, you also configure API Hub add-ons, which determine whether only API metadata, or both metadata and runtime data, will be processed. The API Hub provisioning server then establishes the necessary internal mappings for the given Gateway ID and your organization name.
- Apigee Edge opt-in: Once the Plugin Instance is ready, you explicitly enable API Hub connector for a specific Apigee Edge organization by making a management API call. In this call, you provide the
gatewayId(Instance Resource Name) that links your Edge organization to the designated API Hub instance. This action triggers the API Hub connector service within Apigee Edge. - Data synchronization:
- Metadata synchronization: Apigee Edge begins to automatically extract and transmit API metadata (e.g., API proxy configurations, OpenAPI specifications) to the associated API Hub instance. This synchronization ensures that your API definitions are continuously updated in API Hub.
- Runtime data synchronization: If the relevant add-ons are enabled in API Hub, Apigee Edge also collects and sends runtime data (e.g., traffic analytics, error rates) to API Hub. This provides operational insights into your APIs in a centralized location.
- Continuous monitoring & updates: The API Hub connector integration continuously monitors for changes in your Apigee Edge APIs (e.g., new deployments, modifications) and automatically pushes these updates to API Hub. The status of the integration can be queried via Edge management APIs. The processing of metadata and runtime data adapts dynamically based on the state of the API Hub Plugin Instance and its configured add-ons.
This seamless data flow ensures that API Hub always reflects an up-to-date and comprehensive view of your APIs managed within Apigee Edge.