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 and normalize API details from Apigee Edge applications into the ServiceNow Configuration Management Database (CMDB). This integration supports maintaining a comprehensive and consistent API inventory across your organization’s API ecosystem.
Show less
Supported ServiceNow versions include Yokohama, Zurich, and Australia releases.
Key Features
- Import Apigee Edge data such as organizations, managed APIs, frontends, backends, product bundles, and consumer subscription information.
- Normalize imported data into a consistent CMDB data model to ensure uniformity across multiple technologies.
- Use the connector to maintain an end-to-end inventory, tracking APIs from customer-facing endpoints to backend services.
- Monitor API product bundles and their relationships to managed APIs.
- Track API consumer subscriptions and access details for governance and analysis purposes.
- Configure and manage connector connections via the SGC Central view in CMDB Workspace for lifecycle management, including discovery, installation, monitoring, and debugging.
Data Mapping and Integration
The connector pulls data periodically from Apigee Edge and maps it into CMDB Configuration Item (CI) classes using the Robust Transform Engine (RTE), with reconciliation handled by the Identification and Reconciliation Engine (IRE).
Key data sources and their mappings include:
- Organizations mapped to Apigee API Gateways
- Managed APIs and API deployments
- Frontend and backend APIs
- API products and product bundles
- API consumer subscriptions and access details
- Consumers and related key-value data
Staging tables capture raw data before transformation into target CMDB tables, ensuring data integrity and traceability.
For detailed data maps, customers can utilize the IntegrationHub ETL app to view and manage data transformations.
Practical Benefits for ServiceNow Customers
- Gain visibility into API relationships and dependencies to improve impact analysis and incident management.
- Effectively govern API consumption and access through detailed consumer subscription tracking.
- Maintain an accurate and up-to-date CMDB reflecting your API ecosystem within Apigee Edge.
- Streamline connector configuration and lifecycle management using the SGC Central interface, reducing administrative overhead.
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 website 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.