支払方法マニフェスト

この文書の ステータス

HEAD / HTTP/2
Host: alicepay.com
User-Agent: Mellblomenator/9000

HTTP/2 204
Link: </pay/payment-manifest.json>; rel="payment-method-manifest"

{
  "default_applications": ["https://alicepay.com/pay/app/webappmanifest.json"],
  "supported_origins": [
    "https://bobpay.xyz",
    "https://alicepay.friendsofalice.example"
  ]
}

2. マニフェスト形式

妥当な支払方法マニフェストファイルは、JSON オブジェクトとして解析可能な 内容を含む、UTF-8 エンコードされたファイルである。 結果として得られる JSON オブジェクトは、 "default_applications" および "supported_origins" という可能なキーを持つ、最大 2 つの項目を含まなければならない。

default_applications キーの値は、存在する場合、空でない JSON 配列でなければならない。 配列内の各項目は、結果として解析されたURL のスキームが "https" であるような、絶対 URL 文字列でなければならない。

supported_origins キーの値は、存在する場合、文字列 "*"、または空でない JSON 配列のいずれかでなければならない。後者の場合、配列内の各項目は、 HTTPS オリジンを表す絶対 URL 文字列でなければならない。形式的には、その文字列は、 結果として解析されたURLの オリジンの直列化と等しくなければならない。

Web 開発者は、すべての支払方法マニフェストが妥当であることを 確保しなければならない。

ファイルの内容に関するすべての適合要件と同様に、これらは Web 開発者向けであり、 実装者向けではない。正確な処理モデル（§3 処理モデルで与えられる）が、実装者がすべての支払 方法マニフェストファイルをどのように処理するかを規定する。 これには無効なものも含まれる。

{
  "default_applications": ["https://alicepay.com/pay/app/webappmanifest.json"],
  "created_by": "Alice",
  "created_in": "Wonderland"
}

3. 処理モデル

3.1. Payment Request API への変更

この仕様は、PaymentRequest(methodData, details, options) コンストラクターを変更することで、Payment Request エコシステムの残りの部分と統合する。 これは、アルゴリズムが完了して新しく構築された PaymentRequest オブジェクトを返す前に、次のステップを追加する。 以下では、request を構築中の PaymentRequest インスタンスとする。 [PAYMENT-REQUEST]

1. identifiers を、request.[[serializedMethodData]] 内の各ペアの最初の項目からなるリストとする。

2. client を現在の設定オブジェクトとする。

3. identifiers および client を与えて、 支払方法マニフェストを取り込む。

これらのステップがプロセス全体を開始する。§3 処理 モデルの残りは、このプロセスが最終的にどのようにして 新しい支払 アプリをユーザーが利用可能にするのかを定義することに関わる。

この仕様が 複数実装者の関心を得るにつれて、この節をここで monkeypatch として維持するのではなく、 Payment Request API 仕様自体に移すことを想定している。

3.2. 支払方法マニフェストの取り込み

支払方法識別子のリスト identifiers と、 環境設定オブジェクト client が与えられたとき、 ユーザーエージェントは、支払方法マニフェストを取り込むために、次のステップを実行してもよい:

1. identifiers および client を与えて、 支払方法マニフェストを取得する。そしてこれが manifestsMap で非同期に完了するのを待つ。結果が失敗の場合、戻る。

2. manifestsMap の各 identifier → manifest について、 それぞれに対し:

   1. parsed を、manifest を検証し解析した結果とする。これが 失敗を返す場合、continue する。

   2. parsed のdefault applications内の各 url について、それぞれに対し:

      1. client を与えて、url にあるWeb アプリマニフェストを取得する。そしてそれが webAppManifestString で 非同期に完了するのを待つ。結果が失敗の場合、continue する。

      2. webAppManifest を、webAppManifestString を与えて Web アプリ マニフェストを処理するステップを実行した結果とする。

         Web アプリ マニフェストを処理するステップは非常に寛容であり、 失敗する代わりに、空のオブジェクトや重要なフィールドを欠いたオブジェクトを 返す。ユーザーエージェントは、次のステップでの目的に十分なデータを含むことを 確保するため、処理済み Web アプリマニフェストを 別途検証する必要がある。

      3. ユーザーエージェント固有の方法で、結果として得られた処理済み Web アプリマニフェスト webAppManifest を使用して、identifier により識別される 支払方法に適用可能な支払アプリをインストールする。

         将来的には、結果として得られた処理済み Web アプリマニフェストを使用するための、 ユーザーエージェント非依存の方法が存在する予定である。それは、その serviceworker フィールドを参照し、それを使用して Payment Handler API 仕様に適合する Web ベースの支払アプリをインストールすることによる。 [PAYMENT-HANDLER]

   3. supported originsを identifier に関連付ける。それにより、ユーザーエージェントは将来、 identifier により識別される支払方法に対して、どのサードパーティの支払アプリを表示できるかを判断するために それを使用できる。

3.3. 支払方法マニフェストの取得

リストである JavaScript 文字列 supportedMethods と、環境設定オブジェクト client が与えられたとき、 支払 方法マニフェストを取得するには、次のステップを実行する。 このアルゴリズムは、URL から バイト列へのマップ（空の場合もある）で 非同期に完了する。このマップは、支払方法識別子を対応するマニフェストの内容に対応付ける。

1. identifierURLs を空のリストとする。

2. supportedMethods の各 string について、 それぞれに対し:

   1. identifierURL を、string を基本 URL 解析した結果とする。結果が失敗の場合、 continue する。

      結果は、URL ベースの支払方法 識別子ではない支払方法識別子、すなわち 標準化された支払方法 識別子について失敗となる。

   2. identifierURL を検証した結果が false の場合、continue する。

   3. 任意で、continue する。

      このステップにより、実装はユーザーエージェント固有の理由で、 提供された支払方法 識別子のいずれかをスキップできる。§4 セキュリティと プライバシーに関する考慮事項では、ユーザーエージェントが特定の識別子だけを取り込むことを 好む可能性がある理由の一部を論じる。

   4. identifierURL を identifierURLs に追加する。

3. manifestsMap を空のマップとする。

4. identifierURLs の各 identifierURL について、 それぞれに対し:

   1. identifierRequest を新しいrequestとする。そのmethod は `HEAD`、url は identifierURL、client は client、mode は "cors"、credentials mode は "omit"、そして redirect mode は "error" である。

   2. identifierRequest をFetchする。response identifierResponse で process response するには:

      1. identifierResponse がnetwork errorであるか、 identifierResponse のstatus がok statusでない場合、continue する。

      2. linkHeaders を、`Link` と identifierResponse の header list を与えて header list values を抽出した結果とする。

      3. manifestURLString を null とする。

      4. linkHeaders の各 linkHeader について、 それぞれに対し:

         1. link-value 生成規則に従って linkHeader を解析する。解析できない場合、 continue する。 [RFC8288]

         2. 解析されたヘッダーが、名前が文字列 "rel" とASCII 大文字小文字無視で一致し、 値が文字列 "payment-method-manifest" とASCII 大文字小文字無視で一致する パラメーターを含む場合、manifestURLString を、解析されたヘッダー内の URI-Reference 生成規則により与えられる文字列に設定し、 break する。

      5. manifestURLString が null でない場合、次を行う:

         1. manifestURL を、identifierResponse のurl をベース URL として与え、 manifestURLString を基本 URL 解析した結果とする。結果が 失敗の場合、continue する。

         2. manifestURL のscheme が "https" でない場合、 continue する。

         3. manifestRequest を新しいrequestとする。そのurl は manifestURL、client は client、mode は "cors"、credentials mode は "omit"、そして redirect mode は "error" である。

         4. manifestRequest をFetchする。response manifestResponse で process response end-of-body するには:

            1. manifestResponse がnetwork errorであるか、 manifestResponse のstatus がok statusでない場合、continue する。

            2. body を manifestResponse のbodyとする。

            3. body が null の場合、continue する。

            4. reader を、body からreader を取得した結果とする。

            5. promise を、reader を用いて body から すべての バイトを読み取った結果とする。

            6. Upon fulfillment of promise with a byte sequence bytes, set manifestsMap[identifierURL] to bytes.

5. 上記のステップにより開始された進行中のすべてのfetchアルゴリズムが完了したら、 指定されたprocess response および process response end-of-body ステップを含め、 このアルゴリズムを manifestsMap で非同期に完了する。

3.4. 支払方法マニフェストの検証と解析

解析済み 支払方法マニフェストは、次の 2 つのフィールドを含む構造体である:

default applications

URLの 順序付き集合。空の場合もある

supported origins

文字列 "*"、またはオリジンの順序付き集合

支払方法マニフェストを含むと称するバイト列 bytes を検証し解析するには、次の ステップを実行する。結果は、解析済み支払方法マニフェスト、または失敗のいずれかである。

1. parsed を、ユーザーエージェント定義のJavaScript realm において、bytes を与えて バイトから JSON を解析した結果とする。これが例外を投げる場合、失敗を返す。

2. Type(parsed) が Object でない場合、 失敗を返す。

3. defaultApps を空の順序付き集合とする。

4. defaultAppsValue を Get(parsed, "default_applications") とする。

5. defaultAppsValue が undefined でない場合:

   1. IsArray(defaultAppsValue) が false の場合、 失敗を返す。

   2. defaultAppsList を CreateListFromArrayLike(defaultAppsValue, « String ») とする。これが例外を投げる場合、失敗を返す。

   3. defaultAppsList のサイズが 0 の場合、失敗を返す。

   4. defaultAppsList 内の各 defaultAppString について、 それぞれに対し:

      1. defaultAppURL を、defaultAppString を基本 URL 解析した結果とする。結果が失敗の場合、 失敗を返す。

      2. defaultAppURL のscheme が "https" でない場合、失敗を 返す。

      3. defaultAppURL を defaultApps に追加する。

6. supportedOrigins を空の順序付き集合とする。

7. supportedOriginsValue を Get(parsed, "supported_origins") とする。

8. supportedOriginsValue が "*" である場合、supportedOrigins を "*" に設定する。

9. そうでなく、supportedOriginsValue が undefined でない場合:

   1. IsArray(supportedOriginsValue) が false の場合、 失敗を返す。

   2. supportedOriginsList を CreateListFromArrayLike(supportedOriginsValue, « String ») とする。これが 例外を投げる場合、失敗を返す。

   3. supportedOriginsList のサイズが 0 の場合、失敗を 返す。

   4. supportedOriginsList 内の各 supportedOriginString について、 それぞれに対し:

      1. supportedOriginURL を、supportedOriginString を基本 URL 解析した結果とする。結果が失敗の場合、 失敗を返す。

      2. supportedOriginURL のscheme が "https" でない場合、失敗を 返す。

      3. supportedOriginURL のusername または password が空文字列でない場合、 失敗を返す。

      4. supportedOriginURL のpath のサイズ が 0 でない場合、失敗を返す。

      5. supportedOriginURL のquery または fragment が null でない場合、失敗を返す。

      6. supportedOriginURL のorigin を supportedOrigins に 追加する。

10. default applications が defaultApps により与えられ、supported origins が supportedOrigins により与えられる、新しい解析済み支払方法マニフェストを返す。

{
  "default_applications": ["https://alicepay.com/pay/app/webappmanifest.json"],
  "supported_origins": []
}

3.5. Web アプリマニフェストの取得

支払 アプリの決定は、埋め込まれた HTML 文書とは独立して行われるため、 既定の支払アプリに関する情報を与えるWeb アプリマニフェストを取得する手順は、通常の Web アプリマニフェストを取得するステップとは異なる。

URL url と 環境設定オブジェクト client が与えられたとき、 既定の 支払アプリの Web アプリマニフェストを取得するには、次の ステップを実行する。このアルゴリズムは、 スカラー値 文字列または失敗のいずれかで非同期に完了する。

1. request を新しいrequestとする。 そのurl は url、client は client、mode は "cors"、credentials mode は "omit"、そして redirect mode は "error" である。

2. request をFetchする。response response で process response end-of-body するには:

   1. response がnetwork errorであるか、response のstatus がok statusでない場合、 このアルゴリズムを失敗で非同期に完了する。

   2. body を response のbodyとする。

   3. body が null の場合、このアルゴリズムを失敗で非同期に完了する。

   4. reader を、body からreader を取得した結果とする。

   5. promise を、reader を用いて body からすべてのバイトを読み取った結果とする。

   6. promise が充足されたとき、バイト列 bytes を伴うなら、このアルゴリズムを、 bytes をUTF-8 デコードした結果で非同期に完了する。

   7. promise が拒否されたとき、このアルゴリズムを失敗で非同期に 完了する。

4. セキュリティとプライバシーに関する考慮事項

支払方法マニフェストを取り込むことは、 エンドユーザーの活動に関する情報を支払サービスに明らかにする可能性がある。たとえば、 ある 1 つの Web サイト上でのみサポートされる支払方法は、その支払プロバイダーが その Web サイトを訪問したユーザーの IP アドレスを発見できるようにする可能性がある。

これを軽減する 1 つの方法は、ユーザーがインストールしている、または明示的に関心を示した 支払アプリについてのみマニフェストを取得することである。これにより、リスクは ユーザーの IP アドレスをそれらの当事者とのみ共有することに限定される。

5. IANA に関する 考慮事項

5.1. payment-method-manifest リンク関係

この登録はコミュニティレビューのためのものであり、レビュー、承認、 および IANA への登録のために IESG に提出される。

関係名

payment-method-manifest

説明

Web Payments エコシステム内の特定の支払方法を記述する支払方法マニフェストへのリンク。

参照

https://w3c.github.io/payment-method-manifest/

注記

そのようなリンクが取得されることが期待される具体的な方法については §3.3 支払方法マニフェストの取得を参照し、それらが使用されるより大きな文脈については §3.2 支払方法 マニフェストの取り込みを参照。

謝辞

§3 処理モデルは、Rouslan Solomakhin により最初に概説されたアルゴリズムに 大きく基づいている。