API Service Graph Connector for Azure API Management
Summarize
Summary of API Service Graph Connector for Azure API Management
The ServiceNow API Service Graph Connector for Azure API Management enables customers to import detailed API information from Azure API Management applications into the ServiceNow Configuration Management Database (CMDB). This integration provides a consistent, normalized data model across technologies, enhancing API visibility, governance, and collaboration without requiring direct access to Azure.
Show less
The connector supports ServiceNow versions Yokohama, Zurich, and Australia and is part of a broader API Insights workspace that centralizes API data analysis and interaction.
Key Features
- Normalized Data Import: Ensures consistent API data modeling across technologies for reliable CMDB population.
- API Insights Workspace: Offers a centralized interface for analyzing and managing API data, improving governance and collaboration.
- Use Cases:
- Maintain comprehensive inventories of exposed and backend APIs, tracking usage and ownership.
- Trace APIs from customer endpoints to backend services to quickly identify impacted endpoints, facilitating incident creation.
- Manage vulnerabilities and compliance requirements related to API endpoints.
- Data Mapping and Integration: Uses the Robust Transform Engine (RTE) and Identification and Reconciliation Engine (IRE) to map and reconcile data from Azure API Management into CMDB Configuration Items (CIs).
- Soft Deletion: Supports marking undiscovered CMDB CI records as Non-Operational instead of permanent deletion, ensuring data integrity.
Configuring the Connector
Customers configure the connector via the SGC Central view within the CMDB Workspace. This view streamlines discovery, installation, lifecycle management, monitoring, and debugging of connections. Using SGC Central is the recommended configuration approach, as the older guided setup method is deprecated.
Data Sources and Mapping
The connector extracts data from multiple Azure API Management data sources, staging it in intermediary tables before transforming and loading it into specific CMDB CI classes and non-CMDB classes. Key data includes API Management services, managed APIs, frontend and backend APIs, API consumers, products, subscriptions, tags, and consumer access details.
ServiceNow customers can review and manage these data maps using the IntegrationHub ETL application, facilitating customized data integration and troubleshooting.
Practical Benefits for ServiceNow Customers
- Gain a unified and accurate API inventory that spans customer-facing and backend services.
- Enhance incident response by understanding API dependencies and impacted endpoints.
- Improve security posture by tracking vulnerabilities and enforcing compliance requirements on APIs.
- Maintain CMDB accuracy with automated soft deletion and reconciliation processes.
- Leverage a centralized workspace to analyze API performance and usage without needing direct Azure access.
Use the ServiceNow® API Service Graph Connector for Azure API Management to import API details from an Azure API Management 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.
The API Insights workspace provides a centralized interface where you can analyze and interact with API data, without needing direct access to Azure API Management, 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.
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 Azure API Management using SGC Central.
Data mapping
Data from the Azure API Management 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 Azure API Management application.
| Data source | Staging table | Target tables |
|---|---|---|
| API Management Services | SGA Azure API Management [sn_azure_api_gw_sga_azure_api_management] | Azure API Management |
| Managed API | SGA Azure Managed API [sn_azure_api_gw_sga_azure_managed_api] | Managed API |
| API Frontend Backend | SGA Azure API Frontend Backend [sn_azure_api_gw_sga_azure_api_frontend_backend_import] | API Frontend |
| API GraphQL Frontend Backend | SGA Azure API GraphQL Frontend Backend [sn_azure_api_gw_sga_azure_api_graphql_frontend_backend] | API Frontend |
| API Consumer | SGA Azure API Consumer [sn_azure_api_gw_sga_azure_api_consumer] | API Consumer |
| API Product | SGA Azure API Product [sn_azure_api_gw_sga_azure_api_product] | API Product Bundle |
| API Consumer Subscription | SGA Azure API Consumer Subscription [sn_azure_api_gw_sga_azure_api_subscription] | API Consumer Subscription |
| API Tag | API Tag [sn_azure_api_gw_api_tag] | Key Value |
| API Consumer Access | SGA Azure API Consumer Access [sn_azure_api_gw_sga_azure_managed_api] | API Consumer Access |
For more information on where data is saved when pulling data from an Azure API Management application, see Target tables for storing API Service Graph Connector for Azure API Management 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.