API管理シナリオ

API管理シナリオのケースを通じて、組織内で一般的な 14 のAPI管理機能要件のケースについて学び、シナリオのデモンストレーションは、企業が使用シナリオを自社の組織に適用するのをより効果的に支援することができます。

ケースカンパニー

TPIソフトウエアは、企業や顧客が企業に必要なサービスをより迅速かつ柔軟に構築できるよう、さまざまな API リソースを提供する「API as a Service」を提供するテクノロジー企業です。

TPIソフトウエアの API 戦略とリソース計画を担当する技術チームは、マネージャーの Lin とそのチームメンバーです。 API の数の増加とAPI管理におけるさまざまなニーズに直面して、マネージャーの Lin は、すべての関係者の要件を満たすために自分とチームが多くの時間とコミュニケーションを費やし、リソースの混乱により手戻りや部門間/内部での作業が必要になることがよくあることに気付きました。対外コミュニケーションにおけるギャップです。

会社の API リソースをより効果的に制御して戦略的相乗効果を達成するために、マネージャーのリンは、社内および社外に対応するためのさまざまな API と豊富なAPI管理メカニズムを単一のインターフェイスで簡単に管理できる、会社の API リソース管理センターとしてdigiRunner API 管理 プラット フォームを導入しました。のニーズに応え、チームの技術的な運用コストを大幅に削減し、コミュニケーション効率を効果的に向上させます。その中でも、マネージャー リンの技術チーム、プラットフォーム開発部門、財務部門は、社内および社外の顧客に提供するために組織内で最も頻繁に使用される API サービスの 1 つです。

シナリオ 1: プラットフォームの使用権

このシナリオでは、digiRunnerで組織図を構築し、さまざまなレベルに対応するプラットフォーム権限とさまざまな機能モジュールを与える方法を理解できるようになります。

ユーザーケース

プラットフォーム開発部門と財務部門は、チームの API 開発と API ライフサイクルの管理プラットフォームとしてdigiRunnerを使用することを希望しており、両部門は独自の組織権限仕様を持ち、メンバー (承認者、IT、承認者、IT、組織) に提供するさまざまな機能モジュールを必要としています。開発者)に関連する作業を実行します。

リン マネージャーのチームは、プラットフォームの最高権限部門 (HQ_Admin) として、財務部門 (BU-1) のニーズに基づいて垂直組織構造を設計し、さまざまなロール ユーザー (管理者承認者など) にさまざまな権限と機能を割り当てます。組織の中で。

BU-1 Admin_Approver が許可するコンテンツには次のものが含まれます。

認可権限:

  • 権利管理: ユーザーの保守/個人データの保守
  • クライアント管理: クライアントのメンテナンス
  • API管理:APIリスト
  • ユーザー資格情報管理: すべて
  • レポート: すべて
  • 各種申請書:サインオフ作業
  • システム現況照会:APIキー現況照会/オンライン棚状況照会/スケジュール操作/サイクルスケジューリング/出荷履歴

承認ロール (Admin_Approver として、部下を承認できるロールのリストが割り当てられています):

  • ユニットスーパーバイザー: bu_admin_appr
  • ユニットシステム管理者: bu_admin_it
  • ユニット開発者: bu_dev

ステップ

ステップ 1: 組織単位のメンテナンス
「権限管理」→「組織単位のメンテナンス」をクリックして組織を確立します。

構築する組織(BU-01、Admin_Approver)の関連情報を入力し、[追加]をクリックして組織ノードを作成します

ステップ 2: キャラクターの確立
[権限管理] > [ロールのメンテナンス] をクリックしてロール (BU_Admin_Approver) を作成します。
「ロールコード」、「ロール名」を入力し、このロールが使用できる「機能リスト」をクリックし、[作成]をクリックします。
ステップ3:ロールリストの設定
「権限管理」>「ロール一覧設定」をクリックし、「BU_Admin_Approver」に権限のあるロールを付与します。許可されたロールのリスト: BU_Admin_Approver、BU_Admin_IT、BU_dev
ステップ 4: ユーザーの作成
[権限管理] > [ユーザー管理] をクリックし、BU-01 組織に属するユーザー: bu01_admin-appr を作成し、新しく作成したロール (BU_Admin_Approver) をこのユーザーに付与して、そのロールの承認された機能を使用できるようにします。

シナリオ 2: API プロキシ

このシナリオでは、統合ホスティングのためにさまざまな AP サーバー上の API をdigiRunnerに登録する方法を理解できます。

ユーザーケース

財務部門には多数の API (AP、DB、FTP...) が異なるサーバー上に存在しており、異なるサーバー上で管理するのは容易ではないため、メンテナンスを軽減するために単一のプラットフォーム上で統一して管理できることが望まれます。時間と費用。digiRunnerの API プロキシ サービスを使用すると、API URL (http/https) または Swagger ファイルを通じてdigiRunnerプラットフォームに API を簡単に登録できます。 「currencyRate」 この為替レートクエリ API も今回digiRunnerプロキシする API の 1 つであり、この API をデモンストレーションに使用します。

ステップ

ステップ 1: API の登録
「API管理」>「API登録」をクリックしてAPI(currencyRate API)を登録します。
(すでに Open API ファイルをお持ちの場合は、このページでアップロードするファイルを選択することもできます)
ステップ 2: カスタム API
[カスタマイズ]をクリックし、「ソースURL」、「モジュール名」、「API ID(APIキー)」、「HTTPメソッド」を入力し、また、為替レートは公開情報なので特別な権限は必要ありませんので、「」にチェックを入れてください。認証なし 「必須」を選択後、[登録]をクリックすると登録が完了します。
ステップ 3: API を有効にする
手順2を完了すると、「APIリスト」に新しく登録された「currencyRate」APIが表示されます。起動したいAPIにチェックを入れて「開始」をクリックし、APIを起動します(ステータスランプが緑色になり正常に起動されます)。

シナリオ 3: API 暗号化

このシナリオでは、digiRunner管理プラットフォームを使用して、プログラミングを行わずに API (JWE/JWS) を暗号化する方法を学びます。

ユーザーケース

TPIソフトウエア、情報セキュリティの考慮事項に基づいて、情報送信のセキュリティを確保するために、API を含むすべての機密情報を組織外または組織間で送信する場合は暗号化する必要があると発表しました。

digiRunner管理プラットフォームは、追加のプログラムを作成することなく API を暗号化する機能を提供します。リンマネージャーや財務部門の開発者など、プラットフォーム上で API 編集権限を持つユーザーは、プラットフォーム上で登録したエージェントの API を暗号化できます (JWE/ JWS)、digiRunnerの API リストには、サポートされている API が暗号化されているかどうかに関する情報も提供されます。ここでは暗号化対象の例として「fileTransform」形式変換APIを使用します。

ステップ

ステップ 1: API リストを検索する
「API管理」>「APIリスト」をクリックし、暗号化する「ファイルトラムフォーム」APIを照会して[検索]をクリックします。
ステップ 2: API を更新する

APIを確認後、[更新]をクリックして設定を行います。

「JWT設定」を開き、「リクエスト」と「レスポンス」の暗号化方式を設定し、設定後[更新]をクリックして変更を保存します。

ステップ 3: JWT の設定
暗号化に関する情報は「API一覧」の「JWT設定」欄で確認できます。

シナリオ 4: API 切り替え

このシナリオでは、digiRunner管理プラットフォームを通じて API を簡単に有効または無効にする機能を体験します。

ユーザーケース

マネージャーの Lin と彼のチームは、毎年digiRunner上のすべての API をインベントリしてクリーンアップし、使用されなくなった API やセキュリティ上の懸念がある API を閉じます。その中で、バックエンド システムのシリアル API「backendConnection」は現在使用されていないものの 1 つです。 API: API では、管理プラットフォーム上でいくつかの簡単な手順を実行するだけで、API のシャットダウンを完了できます。

ステップ

ステップ 1: API リスト

「API管理」>「API一覧」をクリックし、使用を停止したいAPI「backendConnection」を入力し、[検索]をクリックします

ステップ 2: API を選択する
APIを確認後、[停止]をクリックしてAPIを停止します。
ステップ 3: API を無効にする
無効化された API は API リストに引き続き表示されますが、ステータス ライトは赤になります。

シナリオ 5: API 属性グループの管理

このシナリオでは、digiRunnerが提供する API グループ管理機能について学び、同じ属性とセキュリティ レベルを持つ API をグループ化し、プラットフォーム ユーザーに一度に認可します。

ユーザーケース

情報セキュリティを確保するために、すべての API はdigiRunnerエージェントに登録するときにセキュリティ レベルを示す必要があり、ユーザーは安全とマークされ、自分の API と同一である API のみを検索できます。

マネージャーの Lin と彼のチームは、API のインベントリを作成するときに同時にセキュリティ分類とさまざまな属性に従って API をグループ化しました。これにより、新しいユーザーが API リソースにアクセスする必要があるときに、API の「グループ」全体がユーザーに直接許可されるようになりました。 1 つずつ承認されるため、管理時間が大幅に節約されます。
APIグループ
同社の API セキュリティ仕様によると、TPIソフトウエア内部スタッフと認定パートナーによって構築されたすべての API は、「システム セキュリティ」システム セキュリティとしてマークされています。同時に、分類管理を容易にするために、 API は分類の基礎にもなります。 「Composer」グループは、組織内の API グループの 1 つです。
ユーザー管理
Xinli のサードパーティ パートナーである Andy も、digiRunnerで提供される Composer API を使用して API 開発をスピードアップしたいと考えています。仕事に必要な API を取得できるようにするために、Manager Lin はセキュリティ レベルに一致する API グループを直接承認します。いちいち認証するのではなく、APIの認証作業を素早く完了させます。

ステップ

APIグループ
ステップ 1: グループを追加する
「クライアント管理」>「グループメンテナンス」をクリックし、「グループ追加」をクリックしてデータを作成します
ステップ 2: 機能モジュールを選択する

グループ名: 作曲家
グループの作成に必要な関連情報を入力した後、[モジュールの選択]をクリックして、グループに許可するモジュールを選択します。

[選択を適用]をクリックすると、選択した機能モジュールが適用されます。
ステップ 3: API を選択する

[APIを選択]をクリックして、所属するAPIを選択します。 「Composer」グループに属する API は、「fileTransform」と「backendConnection」の 2 つの API です。選択後、[選択を適用]をクリックします。

選択したモジュールとAPIを確認し、設定が正常に適用された後、[作成]をクリックしてグループの作成プロセスが完了します
ユーザー管理
ステップ 1: 新しいユーザーを追加する
[クライアント管理] > [クライアント メンテナンス] をクリックしてページに入ります。 [作成]をクリックして新規ユーザー(アカウント:tsp1)を作成し、必要な情報(クライアントアカウント、クライアントコード、クライアント名、パスワード、再確認パスワード、所有者、ステータス、オープンステータス、メールアカウント)を入力して【作成】をクリックします。
ステップ 2: セキュリティ設定
キーワード検索欄にユーザー情報(tsp1)を入力し、[検索]をクリックします。ユーザーを見つけたら、「アクション」列の[セキュリティ]をクリックしてデータを設定します
ステップ 3: グループ認可
[セキュリティ]ボタンをクリック後、画面上の[認可設定]タブをクリックし、[グループの設定]をクリックして設定を行ってください。
ステップ 4: 認証設定
所属するグループをバインドし、ユーザーにバインドするグループ「Composer」、「dppublic (ポータルネットワークパブリックグループ)」、「Public」にチェックを入れ、[更新]をクリックします
ステップ5: トークンの設定
「トークン設定」タブをクリックし、「OAuth付与タイプ」、「アクセストークンの有効期限」、「リフレッシュトークンの有効期限」を設定し、[更新]をクリックして変更を保存し、[リストに戻る]をクリックして設定を完了します

シナリオ 6: API データ形式の変換

(digiRunner Enterprise Edition で利用可能)

ここでは、digiRunnerローコード API エディターを使用して APIデータ形式の変換を簡単に実現する機能を体験していただきます。API が Web サービス (http/https) 形式であれば、簡単に完了できます。形式変換 (例: XML ↔ JSON)。

ユーザーケース

一般に、異なるサーバーに異なる形式で保存されているAPIを管理するのは面倒で難しいですが、digiRunner API 管理 プラット フォームにインポートされたTPIソフトウエアについては、統一的に管理して同じデータに変換する必要があるため、フォーマット化は難しくありません。 Manager LinはXML形式のAPIを持っており、統一されたjson形式に変換する必要がありますが、digiRunnerエディタ(Composer)だけでプログラムを書くことなく簡単かつ迅速に行うことができます。

ステップ

ステップ 1: ターゲット API

「API管理」→「APIリスト」をクリックし、対象のAPIテンプレート(fileTransform)を選択します。 [更新]をクリックして編集画面に入ります。

ステップ 2: API テンプレートをエクスポートする
[Open Editor]をクリックして[DigiRunner Composer]ページに入ります。
右上隅をクリックし、[エクスポート]を選択し、.jsonをエクスポートします。
ステップ 3: 新しい API を作成する
[APIの構成と設計]をクリックし、[モジュール名]、[API ID(APIキー)]、[HTTPメソッド]を入力し、[エディタを開く]をクリックします。
ステップ 4: API Composer をインポートする
[インポート]をクリックして.jsonをインポートします
関数ノードを再度プルします
ステップ 5: 導入
編集後、「Deploy」をクリックします。

シナリオ 7: バックエンド システム インターフェイス

(digiRunner Enterprise Edition で利用可能)

このシナリオでは、ローコードのdigiRunnerエディター (Composer) がもたらす便利な機能を体験します。さまざまな関数ノードをドラッグ アンド ドロップするだけで、必要に応じてバックエンド システム インターフェイスの API をすばやく組み立てることができます。 MQ や SAP RFC などのシステムへの文字列の変換は簡単で負担がありません。

ユーザーケース

TPIソフトウエアdigiRunner企業の API リソース センターとして位置づけており、多くの企業のバックエンド システムとも接続しています。ただし、システムの接続が完了するまでには時間がかかり、特に対象システムが複数ある場合には時間と人手がかかりますが、この際、digiRunerエディタ(Composer)を使用することでプログラミングの負担を軽減することができます。
プラットフォーム開発部門のアーキテクチャエンジニアは、digiRunnerエディター(コンポーザー)上の強力なローコード編集設計により、さまざまな機能ノードをドラッグして接続するだけで、バックエンドシステムインターフェースAPIを5分以内に完成させることができます。

ステップ

ステップ 1: API の構成と設計
[APIの構成と設計]をクリックし、[モジュール名]、[API ID(APIキー)]、[HTTPメソッド]を入力し、[エディタを開く]をクリックします。
ステップ 2: .json をインポートする

[インポート]をクリックしてTemplate API .jsonをインポートします。

ステップ 3: 関数ノードを編集する
関数ノードプル API 関数の編集
ステップ 4: 導入
編集後、「Deploy」をクリックします。

シナリオ 8: API 認可

このシナリオでは、digiRunner管理プラットフォームを通じて API 認証を管理する方法を体験します。digiRunner次の認証方法を提供します: パブリック、API キー、OAuth 2.0 (クライアント資格情報/パスワード/認証コード/暗黙的)

ユーザーケース

Andy はサードパーティ開発部門のエンジニアであり、自分で API を開発する負担を軽減するために、digiRunnerのポータル (digiRunner管理プラットフォーム以外のユーザーも API リソースを取得できるようにする) を通じて特定の API リソースを取得したいと考えています。

Andy のdigiRunnerユーザー設定では、彼の認証方法は OAuth: Client Credentialである必要があります。通常、このタイプの認証は、ユーザーがTPIソフトウエア内部開発 API ではなくパブリック API のみを正常に取得できるようにするために使用されます。主に、次の目的で使用されます。組織外のユーザーに。

ステップ

ステップ 1: クライアント管理
[ユーザー管理] > [ユーザーメンテナンス] をクリックして、ユーザーを検索するためのクエリインターフェイスに入ります (tsp1)
ステップ 2: セキュリティ
「アクション」欄の「セキュリティ」をクリックします
ステップ 3: トークンの設定
「トークン設定」タブを選択します
ステップ 4: OAth 許可タイプ
「OAuth Grant Type」から「Client Credential」を選択し、認証設定を行います。 [更新]をクリックして変更を保存します

シナリオ 9: API テスト

この状況では、digiRunner管理プラットフォームを通じて、digiRunner上のエージェントの API が通常のサービスを提供しているかどうかを迅速に確認する方法を学ぶことができます。

ユーザーケース

財務部門の IT 部門は、「currencyRate」(為替レート) API がまだ適切に動作していることを確認したいと考えています。この確認は、digiRunner管理プラットフォーム上のいくつかの簡単な手順で簡単に完了できます。

ステップ

ステップ 1: API テスト
「APIテストエリア」>「API管理」をクリックし、APIキー(ID)=通貨レートをテストします
ステップ 2: テスト情報を入力する
「トークン」データを設定し、テストする「digiRunner URL」「HTTPメソッド」「リクエストヘッダ」「リクエストボディ」を入力し、「リクエスト送信」をクリックします。
ステップ 3: リクエストを送信する
[リクエスト送信]をクリックし、戻り値が正常に取得できるか確認します。

シナリオ 10: API レポート

このシナリオでは、digiRunnerが提供するレポート機能を使用して、さまざまな API データ (例: 最も多くの呼び出しが行われた API) を迅速に理解し、ユーザーがデータ分析と戦略的洞察をより迅速に生成できるようにする方法を学びます。digiRunner、API 使用率統計、時間と時間の分析、平均時間の計算、トラフィック分析、リクエスト/返信の詳細なクエリなどの複数のレポートを提供します。

ユーザーケース

現在、多くの企業がビジネス戦略を改善するための重要なポイントとして、ユーザーの行動データを収集し、その行動を分析することを望んでいます。TPIソフトウエアの財務部門は、金融 API 戦略をさらに計画するために、ユーザーの間で最も人気のある API を知りたいと考えています。

ステップ

ステップ 1: API の使用数
「レポート管理」 > 「API 使用状況統計」でレポートを取得します。
ステップ2:詳細な条件設定

表示したい期間を選択し、必要に応じて検索条件を追加(フィルターの追加)します。

表示したい API ヒストグラムにマウス カーソルを合わせると詳細が表示されます

ステップ 3 (必須ではありません): CSV を出力する
レポート右上の【】をクリックします。 。 。 ]をクリックし、[検査]を選択してAPIの詳細を確認し、必要に応じてCSVをエクスポートします。

シナリオ 11: API 詳細クエリ (ログ)

(digiRunner Enterprise Edition で利用可能)
このシナリオでは、digiRunner Management Center が提供するレポート機能を使用して API の詳細 (ログ) をクエリする方法を体験します。digiRunner、API 使用状況統計、時間-時間分析、平均時間計算、トラフィック分析、リクエスト/返信の詳細なクエリなどの複数のレポートを提供します。

ユーザーケース

最近、財務部門の IT 部門は、「currencyRate」API 呼び出しで異常なエラーが発生するという報告を頻繁に受けています。問題を解決するには、API の詳細 (ログ) を照会して問題を特定することが最初のステップです。 IT 担当者は、digiRunner管理センターのレポートの詳細クエリにキーワードと関連条件を入力するだけで、すぐに詳細を取得して問題を発見できます。

ステップ

ステップ 1: API の詳細をクエリする
[レポート管理] > [API リクエスト/応答詳細クエリ] をクリックします。
ステップ2:詳細な条件設定
表示したい時間間隔を選択し、必要に応じて検索条件を追加(フィルターの追加)して検索「currencyRate」APIの詳細情報を指定し、設定完了後、[検索]をクリックします。

シナリオ 12: API プロキシのセキュリティ

ここでは、API プロキシ セキュリティ (WAF、トラフィック制御、IP バインディング (ブラック/ホワイト リスト)) のために設計されたdigiRunnerセキュリティ メカニズムについて学びます。

ユーザーケース

会社の情報セキュリティ ポリシーに従って、すべてのTPIソフトウエア担当者は、digiRunner使用するときにユーザーにログインするために会社の内部 IP (111.111.10.100) を使用する必要があります。この設定を完了するには、digiRunner Control Center で特定の IP とフロー制御を簡単にバインドするだけで済みます。

ステップ

ステップ 1: クライアント管理
「クライアント管理」>「クライアントメンテナンス」をクリックし、[追加]をクリックして編集インターフェイスに入ります
ステップ 2: ホスト IP リスト
指定した IP の場所 (IP: 111.111.10.100) を入力し、ホスト名を指定します。
ステップ 3: API クォータ
フロー制御:「APIクォータ」と「TPS」の2つのパラメータで制御「APIクォータ」パラメータが0の場合は無制限

シナリオ 13: API ポータル

(digiRunner Enterprise Edition で利用可能)

これに関連して、digiRunner管理センターを通じて API を開発者ポータルにアップロードして、社内および社外の担当者が API リソースにアクセスできるようにする方法を理解できるようになります。また、ポータル上で API のオープンステータス (内部/外部) を設定し、API ユーザーが 1 つのウィンドウで必要な API を検索し、認可をリクエストできるようにします。

ユーザーケース

財務部門は、「currencyRate」為替レート クエリ API が最も頻繁に呼び出される (最も人気のある) API であることを発見したため、これを開発者ポータルに配置して、内部ユーザーと外部のサードパーティ パートナーの両方が検索して使用できるようにする予定です。サポートAPI。
digiRunner管理プラットフォーム上の組織構造の違いに基づいてユーザーごとに異なる権限制限があるという事実を考慮して、財務部門も最初からdigiRunnerプラットフォーム上で部門の組織図と権限を設計し、さまざまなレベルで権限を制限しました。 API のリストとレビュー プロセスを含め、プラットフォーム上で操作する /role 内の担当者の人数を減らし、API が組織によるレビュー後にのみ公開されるようにします。

ステップ

出品リクエスト

ステップ 1: API リストのリクエスト
「各種申請フォーム」>「API削除・削除」をクリックし、出品情報を入力し、[保存]をクリックして申請フォームを保存してください。
ステップ 2: レビューのために送信する
「各種申請フォーム」>「承認ジョブ」をクリックし、「審査に提出」をクリック
ステップ 3: 進捗状況の追跡
審査に送信した後、同じページで投稿フォームの最新の審査状況を確認できます。 (「各種申請フォーム」>「承認業務」)

レビュー

ステップ 1: 審査対象 (1 回目のパスと 2 回目のパス)
レビュー担当者のアカウントにログイン後、「各種申請フォーム」>「承認ジョブ」をクリックし、「レビュー保留」タブを選択すると、レビュー保留中の項目が表示されます。
ステップ 2: サインオフ (最初のパスと 2 番目のパス)
ステップ 3: 合格 (第 1 レベルと第 2 レベル)
内容を確認し、「承認コメント」に審査結果を記入し、[承認]をクリックします。
監査人は、「レビュー済み文書」タブを選択して、承認された文書を表示できます。 【履歴】をクリックすると履歴が表示されます
ステップ 4: ポータル ネットワーク
すべての署名手順が完了すると、API が正常に起動され、ポータルに表示されます。

シナリオ 14: ポータル ネットワーク管理

(digiRunner Enterprise Edition で利用可能)
このシナリオでは、digiRunner管理プラットフォームでポータル バックエンドを管理し、ポータルでアナウンスを公開する方法を学習します。トピック分類、FAQ、Web サイトについて、サイトマップ、お知らせメンテナンス、Swagger オープン設定などのポータル管理機能を提供します。

ユーザーケース

マネージャーの Lin は、digiRunner管理プラットフォーム上でユーザーが使用できるポータルに新しい API トピック「アカウント サービス (アカウント サービス)」を作成し、ポータル上でこの更新に関するアナウンスをリリースしました。

ステップ

ステップ 1: API トピック
「エントランスネットワーク背景管理」>「テーマカテゴリメンテナンス」をクリックし、テーマを作成し、「テーマ名」を設定して写真をアップロードし、[作成]を押します
ステップ 2: お知らせメンテナンス
「エントランスネットワークバックグラウンド管理」>「アナウンスメンテナンス」をクリックし、新しいAPIテーマを通知するアナウンスメンテナンスを設定します - アカウントサービスが棚にあります
ステップ 3: ポータル ネットワーク
上記のすべての設定については、ポータルで最新の更新情報を確認できます。
API トピックを追加 – アカウント サービス
お知らせ – ポータル ユーザーに新しい API トピックを通知します