API Service Graph Connector for Apigee Edge
Summarize
Summary of API Service Graph Connector for Apigee Edge
The ServiceNow® API Service Graph Connector for Apigee Edge enables customers to import detailed API information from Apigee Edge applications into the Configuration Management Database (CMDB). This integration supports maintaining an accurate and normalized inventory of APIs, their products, subscriptions, and related consumer data within ServiceNow.
Show less
This connector is compatible with ServiceNow versions Yokohama, Zurich, and Australia, and is designed to support end-to-end API lifecycle visibility and governance.
Key Features
- Imports organizations, managed APIs, frontends and backends, product bundles, and consumer subscription data from Apigee Edge.
- Normalizes data into a consistent model aligned with other technologies in the CMDB.
- Enables tracking of API exposure, usage, and ownership details.
- Supports discovery and inventory of Apigee Edge organizations as API gateways within the CMDB.
- Monitors API product bundles and their relationships to managed APIs.
- Tracks API consumer subscriptions and access for governance and analysis.
Practical Use Cases
- Maintaining a comprehensive inventory of exposed and backend APIs, including who uses them and how.
- Mapping customer-facing API endpoints to underlying backend services for impact analysis and incident management.
- Discovering and managing API gateway organizations within the CMDB.
- Monitoring API product bundles and consumer subscriptions to enforce governance policies.
Configuration and Data Integration
Customers configure the connector via the SGC Central view in the CMDB Workspace, which facilitates discovery, installation, and lifecycle management of connections. This interface supports creating, editing, monitoring, and debugging the integration.
Data from Apigee Edge is extracted, transformed, and loaded into the CMDB using the Robust Transform Engine (RTE) and Identification and Reconciliation Engine (IRE). The integration can be set to periodically pull data, ensuring the CMDB remains current.
Key data sources include organizations, managed APIs, frontends/backends, API products, consumer subscriptions, and consumer access details. These are staged in specific tables before being inserted into corresponding CMDB Configuration Item (CI) classes or related tables.
Additional Resources
For visibility into data mappings and transformations, customers can leverage the IntegrationHub ETL application. This helps in understanding how Apigee Edge data is structured within the CMDB and supports customizations if needed.
Use the ServiceNow® API Service Graph Connector for Apigee Edge to import API details from an Apigee Edge application into the Configuration Management Database (CMDB).
Request apps on the Store
Visit the ServiceNow Store to view all the available apps, and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.
Key features
Import organizations, managed APIs, frontends and backends, product bundles, and consumer subscription data from an Apigee Edge application into a normalized data model for consistency across other technologies.
Supported ServiceNow versions
- Yokohama
- Zurich
- Australia
Use cases
- Maintain an end-to-end inventory of exposed and backend APIs, identifying what APIs are published, used, and by whom.
- Track APIs from customer-facing endpoints to the underlying services, identifying impacted endpoints when services change or fail and creating incidents for reported issues.
- Discover and inventory Apigee Edge organizations as API gateways within the CMDB.
- Track API product bundles and their relationships to managed APIs.
- Monitor API consumer subscriptions and consumer access details for governance and analysis.
Configuring a connection for the connector
You can configure a connection for the connector by using the SGC Central view in the CMDB Workspace. The SGC Central view enables you to discover and install connectors, and then effectively manage the full life cycle of creating, editing, monitoring, and debugging connections. To configure the connector using SGC Central, see Configure API Service Graph Connector for Apigee Edge using SGC Central.
Data mapping
Data from the Apigee Edge data sources is mapped and transformed into the CMDB Configuration Item (CI) class definitions using the Robust Transform Engine (RTE). Data is inserted into the CMDB using the Identification and Reconciliation Engine (IRE).
When you complete setting up the connection, you can configure the integration to periodically pull data from an Apigee Edge application.
| Data source | Staging table | Target tables |
|---|---|---|
| Organization | Organization [sn_apigee_edge_organization] | Apigee API Gateway |
| Managed API | Managed API [sn_apigee_edge_managed_api] | Managed API |
| Frontend Backends | Frontend Backends [sn_apigee_edge_frontend_backends] | API Backend |
| API Product | API Product [sn_apigee_edge_api_product] | API Product Bundle |
| API Consumer Subscription | API Consumer Subscription [sn_apigee_edge_api_consumer_subscription] | API Consumer Subscription |
| API Consumer Access | API Consumer Access [sn_apigee_edge_api_consumer_access] | API |
| Consumer | Consumer [sn_apigee_edge_consumer] | API Consumer |
For more information on where data is saved when pulling data from an Apigee Edge application, see Target tables for storing API Service Graph Connector for Apigee Edge data.
You can use the IntegrationHub ETL app to view the data maps. See IntegrationHub ETL for more information.