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

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

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

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

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

    内部 API またはプライベート API は、許可された (テクニカル) ユーザーのみが利用でき、使用制限や規制なしに使用できます。

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

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

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

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

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

    Description (説明) デジタルインターフェイスの説明。インターフェイスの設計の概要を提供します。

    デジタルインターフェイスがどのように価値を付加するか、どのように設計すべきか、どのように使用することを意図しているかなどの詳細を提供できます。

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

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

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

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

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

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