デジタルインターフェイスフォームの作成

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間:5分
  • エンタープライズアーキテクチャ (旧 アプリケーションポートフォリオ管理) で統合用のデジタルインターフェイスを作成します。

    デジタルインターフェイスフォームのフィールド

    フィールド 説明
    名前 デジタルインターフェイスの一意でわかりやすい名前。
    番号 デジタルインターフェイスの数。このフィールドは、DINTF プリフィックス付きで自動的に生成され、編集できません。
    プロバイダービジネスアプリケーション インターフェイスを提供、マネージャー、および所有するプロバイダービジネスアプリケーションの名前。
    注:
    リポジトリにビジネスアプリケーションがない場合、この属性は空にすることができます。天気やファイナンシャルサービスなどのオープンインターフェイスを使用している場合は、インターフェイスを認識し、関連するビジネスアプリケーションなしで追跡するだけです。
    インターフェイスタイプ インターフェイスで使用される API のタイプ。API がパブリックかオープンかを追跡するのに役立ちます。
    注:
    パブリック API またはオープン API の場合、組織がオープンインターフェイスとして公開しない限り、プロバイダービジネスアプリケーションは存在しません。
    次のオプションを使用します:
    • オープン API
    • パートナー API
    • 内部 API

    パブリック API またはオープン API は誰でも利用でき、制限やライセンス契約なしで使用できます。

    内部 API またはプライベート API は、認定された (技術) ユーザーのみが利用でき、使用制限や規制なしで使用できます。

    パートナー API は、API プロバイダーの認定パートナーが利用できます。通常、これらの API には使用に関する特別な契約条件があります。

    親インターフェイスの名前。

    多くの場合、インターフェイスはバンドルされているか、コンポジションの一部です。デジタル統合でデジタルインターフェイスを参照できるため、親インターフェイスを使用します。親インターフェイスに関連するデジタルインターフェイスが、インターフェイスの関連リストに一覧表示されます。

    バージョン インターフェイスのバージョン。このフィールドは、どのデジタル統合がどのバージョンのインターフェイスを使用しているかを追跡するのに役立ちます。
    ライフサイクルステージ インターフェイスのライフサイクルステージ。次のオプションを使用します:
    • 観念化
    • デザイン
    • 展開
    • 運用
    • 提供終了
    ライフサイクルステージステータス インターフェイスのライフサイクルステージステータス。メインのライフサイクルステージにはそれぞれ、1 つ以上のライフサイクルステージステータスを設定できます。たとえば、運用ステージのデジタルインターフェイスは、時間の経過とともにステータスが使用中からメンテナンス中、および廃止待ちに変化する可能性があります。次のオプションを使用します:
    • 観念化:評価中、パイロット
    • デザイン:公認、デザイン、ビルド
    • 展開:テスト
    • 運用:使用中、メンテナンス中、廃止待ち
    • 提供終了:廃止、使用停止
    モデル ID インターフェイスのモデル ID。このフィールドは、インターフェイスモデルの追跡に役立ちます。

    これは、API モデルまたはタイプの独自のバリアントを管理できるアプリケーションモデルテーブルへの参照です。たとえば、テーブル API、添付ファイル API、アグリゲート API、プロセス API などです。このオプションのフィールドは、インターフェイスモデルを追跡するために使用できます。ユースケースに応じて、新しいモデルとモデルカテゴリを追加できます。

    説明 デジタルインターフェイスの説明。インターフェイスの設計面の概要を説明します。

    デジタルインターフェイスがどのように価値を付加するか、どのように設計するか、どのように使用するかなどの詳細を指定できます。

    インターフェイスのバージョンに応じて、さまざまな変更と機能を説明することもできます。これは、アプリケーションオーナーとアーキテクトが使用するインターフェイスバージョンを決定するのに役立ちます。

    表 : 1. [オーナー] セクションフィールド
    フィールド 説明
    事業主 デジタルインターフェイスを所有するビジネス機能の所有者。親ビジネスアプリケーションを所有しているのと同じユーザーでもかまいません。
    IT 所有者 デジタルインターフェイスを所有する IT 組織内のオーナー。親ビジネスアプリケーションを所有しているのと同じユーザーでもかまいません。
    サポート担当者 対象分野の専門家 (SME) またはデジタルインターフェイスのサポートを提供する個人の名前。
    サポートグループ デジタルインターフェイスにサポートを提供するグループの名前。
    表 : 2. 機能セクションフィールド
    フィールド 説明
    プロトコル インターフェイスで使用されるプロトコルのタイプ。API プロトコルは、アプリケーションを規制する仕様です。これらのプロトコルは、アプリケーションプログラミングインターフェイスをソフトウェアと統合するために使用されます。選択肢には、REST、SOAP、LDAP などがあります。
    注:
    このリストはすべてを網羅するものではなく、希望する値を追加することで拡張したり、指定された値を非表示にしたりできます。
    メッセージ形式 インターフェイス内のメッセージの形式。選択肢には、JSON、XML、CSV などがあります。
    注:
    このリストはすべてを網羅するものではなく、希望する値を追加することで拡張したり、指定された値を非表示にしたりできます。
    表 : 3. [認証] セクションのフィールド
    フィールド 説明
    認証タイプ インターフェイスの認証に使用される認証のタイプ。
    次のオプションを使用します。
    • 基本認証
    • OpenID Connect
    • 証明書
    • WS-Security を使用
    • LDAP
    • なし
    • その他

    システム提供の認証タイプを使用することも、独自の認証タイプを追加することもできます。

    認証タイプ インターフェイスの認可に使用される認可のタイプ。
    次のオプションを使用します。
    • OAuth 2.0 トークン
    • JWT Web トークン
    • SAML 2.0 トークン
    • その他
    • 認証なし

    システム提供の認証タイプを使用することも、独自の認証タイプを追加することもできます。

    表 : 4. [アクティビティ] セクションのフィールド
    フィールド 説明
    作業メモ インターフェイスに関するコメント。
    デジタルインターフェイスの作成または更新