Configure settings to manage APIs in API Insights
Configure API Insights settings, including API creation tools, relationship models, ownership groups, and automated workflows, to streamline API governance and operational processes.
Before you begin
Role required: sn_api_insights_ws.api_mgmt_architect_adminor sn_cmdb_admin
Procedure
Navigate to Workspaces > API Insights.
Select the Settings tab.
Turn on the All settings option.
Note: This step is applicable to users with the sn_cmdb_admin role. You can skip this step if you have the sn_api_insights_ws.api_mgmt_architect_admin role.
In the API creation tool section, select an API creation tool from the available options.
| None | Uses no external tool. |
| Digital Integration Management | Uses the Digital Integration Management application \(part of the Enterprise Architecture Workspace\), if enabled, to initiate the API design process by creating a digital interface record. |
| External tool | Uses a third-party tool for API creation, requiring the URL for the external tool (for example, http://www.postman.com ) to be entered in the External API authoring tool URL field. |
In the API-to-business application relationship model section, select a relationship model from the available options.
Option Description CSDM Links an API to an application service and then to business context also called as business application using the Common Service Data Model (CSDM). Digital Integration Management Links an API to a digital interface and then to business context. In the Ownership group section, set the ownership group responsible for managing the API.
| Option | Description |
|---|---|
| Managed by Group | Assigns the API to a specific group responsible for its overall management and governance ensuring the API’s functionality, security, and alignment with business objectives.Note: By default, the SyncOwnershipGroupsOfAPIVersions scheduled job is active, ensuring that the managed by group is synced for the next API version. |
| Change Group | Assigns the API to a group that oversees changes, managing the life cycle to ensure modifications are documented and implemented without disrupting services. |
| Approval Group | Assigns the API to a group handling approvals for actions like changes or deployments, ensuring necessary approvals are secured. |
| Support Group | Assigns the API to a support group responsible for resolving incidents, maintaining stability, and troubleshooting issues. |
In the Configure workflows section, select a workflow for automating an API action.
Note: Workflows are created by your administrator using the Workflow Studio. See Configuring flows for API actions in API Insights.
Select Save.