API Service Graph Connector for Apigee X
Summarize
Summary of API Service Graph Connector for Apigee X
The ServiceNow API Service Graph Connector for Apigee X enables customers to import API proxy details from their Apigee X applications directly into the Configuration Management Database (CMDB). This integration facilitates an end-to-end inventory of APIs, improving visibility and governance across your API environment without requiring direct access to Apigee X. It is compatible with ServiceNow versions Yokohama, Zurich, and Australia.
Show less
Key Features
- Normalized Data Model: Imports API data into a standardized format for consistency across various technologies.
- API Insights Workspace: Provides a centralized interface to analyze and interact with API data, enhancing collaboration and governance.
- Data Integration: Uses Robust Transform Engine (RTE) and Identification and Reconciliation Engine (IRE) to map and insert Apigee X data into CMDB CI classes.
- Soft Deletion: Supports marking undiscovered CMDB CI records as Non-Operational instead of permanently deleting them, preserving historical data.
- Lifecycle Management: Configuration of connections via the SGC Central view allows discovery, installation, monitoring, and debugging of connectors within the CMDB Workspace.
Practical Use Cases
- Maintain comprehensive inventories of published and backend APIs, including details on usage and ownership.
- Trace APIs from customer-facing endpoints to backend services to identify dependencies and impact from changes or failures.
- Support security and compliance efforts by addressing vulnerabilities and monitoring API endpoints.
Important Considerations
- Existing customers upgrading to version 2.3.0 should coordinate with Now Support to avoid issues with source key changes and duplicate records.
- The connector supports periodic data pulls from Apigee X applications, ensuring the CMDB remains up to date.
Data Mapping and Management
The connector processes multiple Apigee X data sources in sequence, staging data in intermediate tables before populating target CMDB CI and non-CMDB tables. These include API organizations, managed APIs, API consumers, frontend/backend components, API products, subscriptions, access, and related Google Cloud Platform organizational structures such as organizations, folders, and projects.
IntegrationHub ETL can be used to view and manage these data maps, providing transparency and control over the data transformation and import process.
Use the ServiceNow® API Service Graph Connector for Apigee X to import API proxy details from an Apigee X 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 data into a normalized data model for consistency across other technologies.
The API Insights workspace provides a centralized interface where you can analyze and interact with API data, without needing direct access to Apigee X, enhancing visibility, governance, and collaboration across the API estate. To learn more, see API Insights.
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.
- Address vulnerabilities and security incidents related to API endpoints, and create compliance requirements to measure against.
Important information for upgrading API Service Graph Connector for Apigee X
If you’re an existing customer using production instances, reach out to Now Support before upgrading to API Service Graph Connector for Apigee X v2.3.0. This upgrade alters source native keys that can impact Source [sys_object_source] table records. Coordinating with Now Support helps to prevent duplicate record creation.
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 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 X using SGC Central.
Data mapping
Data from the Apigee X 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 X application.
| Data source | Staging table | Target tables |
|---|---|---|
| Apigee Organization | SGA Apigee X Apigee Organization [sn_apigee_x_apigee_organization] | Google Organization Project |
| Managed API | SGA Apigee X Managed API [sn_apigee_x_sga_apigee_x_managed_api] | Managed API |
| API Consumer | SGA Apigee X API Consumer [sn_apigee_x_sga_apigee_x_api_consumer] | API Consumer |
| API Frontend Backend | SGA Apigee X Frontend Backend [sn_apigee_x_sga_apigee_x_frontend_backend] | API Frontend |
| API Product | SGA Apigee X API Product [sn_apigee_x_sga_apigee_x_api_product] | API Product Bundle |
| API Consumer Subscription | SGA Apigee X API Consumer Subscription [sn_apigee_x_sga_apigee_x_api_consumer_subscription] | API Consumer Subscription |
| API Consumer Access | SGA Apigee X API Consumer Access [sn_apigee_x_sga_apigee_x_api_consumer_access] | API Consumer Access |
| GCP Organization | SGA Apigee X Organization [sn_apigee_x_sga_apigee_x_organization] | |
| GCP Folder | SGA Apigee X Folder [sn_apigee_x_sga_apigee_x_folder] | Google Organization Folder |
| GCP Project | SGA Apigee X Project [sn_apigee_x_sga_apigee_x_project] | Google Organization Project |
For more information on where data is saved when pulling data from an Apigee X application, see Target tables for storing API Service Graph Connector for Apigee X data.
You can use the IntegrationHub ETL app to view the data maps. See IntegrationHub ETL for more information.
Record removal process
The connector supports soft deletion for CMDB CI classes only, meaning records aren’t permanently removed from the system. Instead, any CMDB CI records not discovered during the last scheduled job run are marked as Non-Operational.