API インサイト の探索
サンプルワークフローを使用して、API インサイト の詳細と、それが組織内のさまざまなユーザーにもたらすメリットについて説明します。
API インサイトの概要
API インサイト は、エンタープライズまたはソフトウェアアーキテクト、および 構成管理データベース (CMDB) アドミニストレーターが組織のアプリケーションプログラミングインターフェイス (API) インベントリを分析してアクションを実行するための一元化されたワークスペースです。
API インサイト ユーザー
| ユーザー | 説明 |
|---|---|
| エンタープライズアーキテクト | sn_api_insights_ws.api_mgmt_architect ロールを持つユーザーは、API インサイト ワークスペースにアクセスして、API の検索、チーム API の監視、管理対象 API の表示、API アクティビティの追跡、API アクセス要求の確認、および API ライフサイクルの側面 (インターフェイス、ビジネスアプリケーション、所有権、または製品モデルのない API も含む) の管理を行うことができます。 |
| エンタープライズアーキテクトアドミニストレーター | sn_api_insights_ws.api_mgmt_architect_admin ロールを持つユーザーは、API インサイトワークスペースへのアクセスと API の検索、API の使用状況に関する測定基準の評価、API を作成するためのパラメーターの設定、ビジネスコンテキストへの API の接続、所有権のグループ属性の指定、API へのアクセスを許可するためのワークフローの関連付けを行うことができます。 |
| CMDB アドミニストレーター | sn_cmdb_admin ロールを持つユーザーは、API 関連の サービスグラフコネクタ を構成および管理できます。クラスタリングの推奨事項の承認または却下、API の検索と比較、CMDB 内の API データ管理に関連する設定の調整を行うことができます。 注: CMDB アドミニストレーターには、一部の機能やデータにアクセスするために、ml_report_user、platform_ml_read、cmdb_inst_adminなどの追加のロールが必要です。 さらに、CMDB アドミニストレーターは特定のウィジェットにアクセスするために次のセキュリティロールが必要です。
|
API インサイトのワークフローの例
- sn_cmdb_admin ロールを持つ CMDB アドミニストレーターは API インサイトにログインし、さまざまなソースから API データをインポートするように API サービスグラフコネクタを構成します。また、スムーズなデータインポートプロセスを確保するために、接続エラーがあるか確認して解決します。
- sn_api_insights_ws.api_mgmt_architect_admin ロールを持つエンタープライズアーキテクトアドミニストレーターは、設定ページにアクセスし、好みに従って所有権設定を調整します。
- sn_api_insights_ws.api_mgmt_architect ロールを持つエンタープライズアーキテクトは、[不足している API データ (APIs missing data)] セクションに移動し、関係と参照を追加して API レコードを拡張します。これには、ビジネスコンテキストの関連付け、所有グループのアサイン、製品モデルのリンク、API 設計の定義が含まれます。
- エンタープライズアーキテクトは、すべての API を一元的に表示し、すべての API を 1 か所に表示する [API] ページを探索します。特定の API にドリルダウンして、所有権、展開場所、コンシューマーの使用状況、セキュリティインシデント、アラートなどの詳細を分析します。さらに、各 API がより広範なエコシステム内でどのように適合するかを評価し、API 関係マップの主要な関係と依存関係を特定します。
API インサイト のメリット
| メリット | 機能 | ユーザー |
|---|---|---|
| 全社的な API の SoR を実装します。 | API インベントリを表示して操作するためのワークスペース | API インサイト アドミニストレーター |
| API を全社的に可視化します。 | さまざまなソースから構成管理データベース (CMDB)への API データの自動検出と取り込み | API インサイト アドミン |
| API をアプリケーションサービスとビジネスコンテキストへマッピングします。 | API を関連するアプリケーションサービスおよびビジネスコンテキストにマッピングするためのワークフロー | API インサイト アドミン |
| サービスグラフコネクタを介して、ソースの幅広いエコシステムからの API データを CMDB に統合します。 | API サービスグラフコネクタを使用した API データの CMDB への取り込み | CMDB アドミニストレーター |
| 関連する API を検索します。 | 分かりやすいインターフェイスを備えた API 検索機能 | API インサイト アドミニストレーター |
| API アクセス要求のワークフロー構成を有効にします。 | API アクセス要求ワークフローのカスタマイズ | API インサイト アドミニストレーター |
| 各 API とそのコンポーネントの使用状況、セキュリティ、およびサービスマッピングを表示します。 | API インベントリ、議事録に従った要求、一意のコンシューマー、セキュリティデータ、IT Operations Management (ITOM) (ITOM) および IT Service Management (ITSM) データ、関係マッピングの詳細ビュー | API インサイトアーキテクト API インサイト アドミン CMDB アドミン |
詳細情報
API インサイトを構成して使用する方法の詳細については、以下を参照してください。