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 allows users to import API proxy details from Apigee X into the Configuration Management Database (CMDB). This integration is crucial for maintaining an organized inventory of APIs and understanding their usage within your organization.
Show less
Key Features
- Imports data into a normalized data model for consistency across technologies.
- Supports ServiceNow versions: Washington DC, Xanadu, Yokohama.
- Enables tracking of both customer-facing APIs and backend services, assisting in incident management and vulnerability tracking.
Use Cases
- Maintain an inventory of APIs, tracking which are published and utilized.
- Identify impacted endpoints when services change or fail, and generate incidents for reported issues.
- Address vulnerabilities and compliance requirements related to API security.
Configuration
To configure the connector, utilize the SGC Central view in the CMDB Workspace for a guided setup, as the traditional setup method is being deprecated. This view facilitates the management of the connector’s lifecycle.
Data Mapping
The connector employs the Robust Transform Engine (RTE) to map data from Apigee X into CMDB Configuration Item (CI) classes. Data can be periodically pulled from an Apigee X application after initial setup. Key data sources and their mappings include:
- Organizations, Folders, Projects, Managed APIs, API Consumers, and more.
Refer to the IntegrationHub ETL app for detailed data maps and storage information regarding the API Service Graph Connector for Apigee X.
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 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 data into a normalized data model for consistency across other technologies.
Supported ServiceNow versions
- Washington DC
- Xanadu
- Yokohama
- Zurich
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.
Configuring a connection for the connector
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 |
|---|---|---|
| Organization | SGA Apigee X Organization [sn_apigee_x_sga_apigee_x_organization] | |
| Folder | SGA Apigee X Folder [sn_apigee_x_sga_apigee_x_folder] | Google Organization Folder |
| Project | SGA Apigee X Project [sn_apigee_x_sga_apigee_x_project] | 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 |
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 are not permanently removed from the system. Instead, any CMDB CI records not discovered during the last scheduled job run are marked as Non-Operational.