API インサイトを使用した API の監視とデータ品質の評価
API インサイトワークスペースの [概要] タブでは、データの取り込みアクティビティと統合の健全性を一元的に表示できます。
[ API インサイト の概要] タブへのアクセス
[概要] タブにアクセスするには、 . デフォルトで [ 概要 ] タブが開きます。
必要なロール
sn_api_insights_ws.api_mgmt_architect または sn_api_insights_ws.api_mgmt_architect_admin ロールが必要です。
ユースケース
組織内のさまざまなユーザーがこのワークスペースをどのように使用するかの例については、次のユースケースを参照してください。
| ユーザー | ワークスペースの使用 |
|---|---|
| エンタープライズアーキテクト | API を検索し、API の比較を行い、API へのアクセスを要求し、データの問題に対処します。 |
| エンタープライズアーキテクトアドミニストレーター | API 作成ツール、ビジネスコンテキスト関係モデル、所有グループなど、API インサイトの設定を管理します。 |
機能
[概要] タブのさまざまなカードにアクセスして、組織で利用可能な API データに関するインサイトを取得します。
| 機能 | 説明 | 必要なロール |
|---|---|---|
| API を検索 | レビューまたは管理する特定の API を見つけるための組織内の API 検索。 |
|
| 受信したアクセス要求 | 受信したアクセス要求の数。API アクセス管理の必要性を示します。 |
|
| 自分のアクセス要求 | ログインユーザーによって作成されたアクセス要求の数。API アクセス管理のアクティビティを示します。 |
|
| 役に立つリソース | 追加のサポートと情報を得るための製品ドキュメント、ナレッジベース記事、コミュニティフォーラムへのリンク。 |
|
| API のデータがありません | ||
| 不足しているビジネスコンテキスト | ビジネスコンテキストがアサインされていない API の数。 |
|
| 不足している所有グループ | 所有グループがアサインされていない API の数。 所有グループにより、修復の追跡とアクセス要求の管理が可能になります。 |
|
| 不足している製品モデル | 製品モデルがアサインされていない API の数。 製品モデルを使用すると、正確なレポート作成と、バージョンアップされた複数の API とのやり取りが可能になります。 |
|
| 欠損設計 | API 構成アイテム (CI) として利用可能で、設計表現のないランタイム API の数。 ランタイム API を、デジタルインターフェイスレコードとして使用できる設計時 API にリンクすると、使いやすさが向上します。 |
|
| チームの API | ||
| すべての API | チームによって管理される API の合計数。 |
|
| 設計中 | 現在設計中の API の数。 |
|
| Operational (稼働中) | 現在使用されている API の数。 |
|
| 終了 | 廃止された API の数。 |
|
| チームが管理する API | ||
| チームが管理するすべての API | ログインユーザーに関連付けられたグループとそのグループにリンクされている API に基づいて、チームによって管理される API の概要。API の詳細には、名前、コンシューマー数、管理プラットフォーム、ライフサイクルステージ、バージョン、および 1 分あたりの要求が含まれます。 [ チームの API (Your team's APIs )] セクションで選択したカードに対応するデータを入力します。 |
|