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

  • リリースバージョン: Australia
  • 更新日 2026年03月12日
  • 所要時間：5分

    • デジタルインターフェイスはビジネスアプリケーションの一部として提供されますが、単独で独立させることもできます。インターフェイスは、他のビジネスアプリケーションがアプリケーションとやり取りする方法を提供します。

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

    フィールド 説明
    名前 デジタルインターフェイスの一意でわかりやすい名前。 インターフェイスの目的を反映するわかりやすい名前を入力します。
    たとえば、顧客管理アプリケーションは、次のような複数のデジタルインターフェイスを公開する場合があります。
    • 顧客プロファイル API — 顧客の ID とプロファイル情報を提供します。
    • カスタマー注文サービス:注文の作成とステータスの更新をサポートします

    すべてのインターフェイスが同じアプリケーションによって提供されますが、各インターフェイスは異なるインタラクションコントラクトを表し、複数のアプリケーションで個別に使用できます。
    番号 デジタルインターフェイスの番号。このフィールドは 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. [アクティビティ] セクションフォームのフィールド
    フィールド 説明
    作業メモ インターフェイスに関するコメント。