Xamarin.iOS の PassKit

[アーティクル]
04/24/2024

iOS ウォレットアプリを使用すると、ユーザーはデバイスにデジタルパスを保存できます。これらのパスは商品の販売元が生成し、メール、URL、または販売元の iOS アプリ内から顧客に送信されます。パスは、映画のチケットからポイントカード、搭乗券まで、さまざまなものに使われます。 PassKit フレームワークを使用すると、開発者はプログラムでパスを操作できます。

このドキュメントでは、ウォレットと、Xamarin.iOS で PassKit API を使用する方法について説明します。

要件

このドキュメントで説明する PassKit 機能には、iOS 6 と Xcode 4.5、Xamarin.iOS 6.0 が必要です。

はじめに

PassKit が解決する主な問題は、バーコードの配布と管理です。以下は、バーコードが現在使われている具体的な例です。

オンラインでの映画チケット購入 - 顧客には通常、チケットを表すバーコードがメールで送信されます。このバーコードを印刷して映画館に持参し、入口でスキャンすると入場できます。
ポイントカード - 顧客は、商品を購入するときに、財布に入っている複数のポイントカードからその店舗のカードを出して提示し、スキャンしてもらいます。
クーポン - クーポンは、印刷可能な Web ページとしてメールで送られたり、郵便物で提供されたり、新聞や雑誌上のバーコードとして配布されます。顧客は、これらを店舗に持ち込み、スキャンしてもらうことで、商品、サービス、割引を受け取ります。
搭乗券 - 映画のチケット購入とほぼ同じです。

PassKit には、これらの場面に対応する代替の方法があります。

映画チケット - 購入後、顧客は (メールまたは Web サイトのリンクを介して) イベントチケットパスを追加します。映画の上映時間が近づくと、パスのリマインダーがロック画面に自動的に表示されるので、映画館に到着したらパスを簡単に開き、ウォレットに表示してスキャンに備えることができます。
ポイントカード - 物理的なカードを提供する (またはそれに加えて何かを提供する) のではなく、店舗は (メールまたは Web サイトへのログイン後に) ストアカードパスを発行できます。店舗側は、プッシュ通知を使用して、パスのアカウントの残高を更新するなどの追加機能を提供できます。また、位置情報サービスを使用して、顧客が店舗の近くにいるときに、パスがロック画面に自動的に表示されるようにすることもできます。
クーポン - クーポンのパスは、追跡機能を持たせて簡単に生成することができ、メールや Web サイトのリンクを介して配布できます。ユーザーが特定の場所に近づいた場合や、特定の日付が来たとき (有効期限が近づいている場合など) に、ダウンロードしたクーポンをロック画面に自動的に表示することもできます。クーポンはユーザーの携帯電話に保存されるため、いつも手元にあり、なくす心配がありません。パスには App Store のリンクを組み込むことができるため、クーポンの提供がコンパニオンアプリのダウンロードを促し、顧客とのつながりが高まる可能性もあります。
搭乗券 - オンラインチェックインプロセスの後、顧客はメールまたはリンクを介して搭乗券を受け取ります。航空会社が提供するコンパニオンアプリにチェックインプロセスを組み込むことができるほか、顧客が自分で座席指定や食事の選択などの追加機能を実行することもできます。航空会社は、フライトの遅延やキャンセルが発生した場合に、プッシュ通知を使用してパスを更新できます。搭乗時間が近づくと、リマインダーとしてパスがロック画面に表示されるため、すばやくパスにアクセスできます。

PassKit が主に提供するのは、iOS デバイスにバーコードを保存して表示するためのシンプルで便利な方法です。時間や場所に合わせてロック画面に通知を表示し、プッシュ通知やコンパニオンアプリケーションを統合することで、洗練されたショッピング、チケット手配、課金サービスの基盤を実現できます。

PassKit エコシステム

PassKit は CocoaTouch 内の単なる API ではなく、バーコードやその他のデータの安全な共有と管理を容易にする、アプリ、データ、サービスの大規模なエコシステムの一部です。この全体図は、パスの作成と使用に関与するさまざまなエンティティを示しています。

エコシステムの各要素には、明確に定義された役割があります。

ウォレット - パスを保存、表示する Apple の組み込みの iOS アプリ。これは、パスが現実世界で使用するためにレンダリングされる唯一の場所です (つまり、バーコードが、パス内のすべてのローカライズされたデータと共に表示されます)。
コンパニオンアプリ - パスの発行者が作成した、パスの機能を拡張 (ストアカードへの価値の追加、搭乗券に記載されている座席の変更、その他のビジネス固有の機能の追加など) するための iOS 6 アプリ。コンパニオンアプリがなくても、パスは便利に利用できます。
サーバー - パスを生成して配布用に署名するためのセキュリティ保護されたサーバー。コンパニオンアプリは、サーバーに接続して新しいパスを生成したり、既存のパスへの更新を要求する場合があります。必要に応じて、パスを更新するためにウォレットが呼び出す Web サービス API を実装できます。
APNS サーバー - サーバーには、APNS を使用して、特定のデバイス上のパスに対する更新をウォレットに通知する機能があります。ウォレットに通知をプッシュすると、変更の詳細を確認するためにサーバーへの問い合わせが行われます。この機能のためにコンパニオンアプリが APNS を実装する必要はありません (ただし、PKPassLibraryDidChangeNotification をリッスンすることはできます)。
コンジットアプリ - パスをコンパニオンアプリのようには直接操作しないが、パスを認識してウォレットに追加できるようにすることで、そのユーティリティを強化するアプリケーション。メールクライアント、ソーシャルネットワークブラウザー、その他のデータ集計アプリはすべて、添付ファイルまたはパスへのリンクに遭遇する可能性があります。

エコシステム全体は複雑に見えますが、一部のコンポーネントは省略可能であり、より単純な PassKit 実装が可能です。

パスとは

パスは、チケット、クーポン、またはカードを表すデータのコレクションです。これは、個人による 1 回の使用を意図している場合 (便名や座席指定などの詳細が含まれる場合)、または複数のユーザーで共有して何度も使用するトークンの場合 (割引クーポンなど) があります。詳しい説明は、Apple のパスファイルに関するドキュメントを参照してください。

型

現在サポートされているのは 5 種類で、ウォレットアプリでは、パスのレイアウトと上部の形で見分けることができます。

イベントチケット - 小さい半円の切切り欠きがあります。
搭乗券 - 左右に V 字型の切り込みがあり、輸送手段を示すアイコン (バス、電車、飛行機など) を指定できます。
ストアカード - クレジットやデビットカードのように上部の角が丸くなっています。
クーポン - 上部にミシン目があります。
一般 - ストアカードと同じく、上部の角が丸くなっています。

このスクリーンショットは、5 つのパスの種類 (クーポン、一般、ストアカード、搭乗券、イベントチケット) を示しています。

ファイル構造

パスファイルは、実際には拡張子が .pkpass の ZIP アーカイブで、特定の JSON ファイル (必須)、さまざまな画像ファイル (省略可能)、ローカライズされた文字列 (省略可能) が含まれています。

pass.json - 必須。パスのすべての情報が格納されています。
manifest.json - 必須。シグネチャファイルとこのファイル (manifest.json) を除く、パス内の各ファイルの SHA1 ハッシュが含まれます。
signature - 必須。 iOS Provisioning Portal で生成された証明書を使用して manifest.json ファイルに署名することによって作成されます。
logo.png - 省略可能。
background.png - 省略可能。
icon.png - 省略可能。
ローカライズ可能な文字列ファイル - 省略可能。

パスファイルのディレクトリ構造を次に示します (これが ZIP アーカイブの内容です)。

pass.json

通常、パスはサーバー上で作成されるため、JSON は形式です。つまり、生成コードは、サーバー上ではプラットフォームに依存しません。各パスには、次の 3 つの重要な情報が含まれています。

teamIdentifier - これにより、生成したすべてのパスが App Store アカウントにリンクされます。この値は、iOS Provisioning Portal に表示されます。
passTypeIdentifier - パスをグループ化するために Provisioning Portal に登録します (複数のタイプを生成する場合)。たとえば、コーヒーショップでは、ストアカードパスタイプを作成して顧客がポイントを獲得できるようにするほか、クーポンパスタイプも別途作成して、割引クーポンを作成、配布できるようにする場合があります。また、同じコーヒーショップがライブミュージックイベントを計画し、そのためのイベントチケットパスを発行することもあります。
serialNumber - この passTypeidentifier 内の一意の文字列。この値はウォレットに対しては非透過的ですが、サーバーとの通信時に特定のパスを追跡するために重要です。

各パスには他にも多数の JSON キーがあります。その例を次に示します。

{
   "passTypeIdentifier":"com.xamarin.passkitdoc.banana",  //Type Identifier (iOS Provisioning Portal)
   "formatVersion":1,                                     //Always 1 (for now)
   "organizationName":"Xamarin",                          //The name which appears on push notifications
   "serialNumber":"12345436XYZ",                          //A number for you to identify this pass
   "teamIdentifier":"XXXAAA1234",                         //Your Team ID
   "description":"Xamarin Demo",                          //
   "foregroundColor":"rgb(54,80,255)",                    //color of the data text (note the syntax)
   "backgroundColor":"rgb(209,255,247)",                  //color of the background
   "labelColor":"rgb(255,15,15)",                         //color of label text and icons
   "logoText":"Banana ",                                  //Text that appears next to logo on top
   "barcode":{                                            //Specification of the barcode (optional)
      "format":"PKBarcodeFormatQR",                       //Format can be QR, Text, Aztec, PDF417
      "message":"FREE-BANANA",                            //What to encode in barcode
      "messageEncoding":"iso-8859-1"                      //Encoding of the message
   },
   "relevantDate":"2012-09-15T15:15Z",                    //When to show pass on screen. ISO8601 formatted.
  /* The following fields are specific to which type of pass. The name of this object specifies the type, e.g., boardingPass below implies this is a boarding pass. Other options include storeCard, generic, coupon, and eventTicket */
   "boardingPass":{
/*headerFields, primaryFields, secondaryFields, and auxiliaryFields are arrays of field object. Each field has a key, label, and value*/
      "headerFields":[          //Header fields appear next to logoText
         {
            "key":"h1-label",   //Must be unique. Used by iOS apps to get the data.
            "label":"H1-label", //Label of the field
            "value":"H1"        //The actual data in the field
         },
         {
            "key":"h2-label",
            "label":"H2-label",
            "value":"H2"
         }
      ],
      "primaryFields":[       //Appearance differs based on pass type
         {
            "key":"p1-label",
            "label":"P1-label",
            "value":"P1"
         }
      ],
      "secondaryFields":[     //Typically appear below primaryFields
         {
            "key":"s1-label",
            "label":"S1-label",
            "value":"S1"
         }
      ],
      "auxiliaryFields":[    //Appear below secondary fields
         {
            "key":"a1-label",
            "label":"A1-label",
            "value":"A1"
         }
      ],
      "transitType":"PKTransitTypeAir"  //Only present in boradingPass type. Value can
                                        //Air, Bus, Boat, or Train. Impacts the picture
                                        //that shows in the middle of the pass.
   }
}

バーコード

サポートされている形式は、PDF417、Aztec、QR の 2D 形式のみです。 Apple によると、1D バーコードは、バックライト付きの携帯電話画面のスキャンには不向きです。

バーコードの下に表示する代替テキストは省略可能です。一部の販売者は、読み取りと入力を手動で行うことを望んでいます。

ISO-8859-1 エンコードは、パスを読み取るスキャンシステムで使用される最も一般的なチェックです。

ローカリゼーション

パスを複数の言語に翻訳するのは、iOS アプリケーションのローカライズと似ています。つまり、.lproj 拡張機能を使用して言語固有のディレクトリを作成し、ローカライズされた要素を内部に配置します。テキスト翻訳は pass.strings ファイルに入力する必要があり、ローカライズされたイメージはパスルートで置き換えるイメージと同じ名前にする必要があります。

セキュリティ

パスは、iOS Provisioning Portal で生成したプライベート証明書を使用して署名されます。パスに署名する手順は次のとおりです。

パスディレクトリ内の各ファイルに対して SHA1 ハッシュを計算します (manifest.json ファイルや signature ファイルは含めないでください。どちらのファイルも、この段階では存在しないことが必要です)。
各ファイル名の JSON キー/値リストとしてハッシュを含めて manifest.json を書き込みます。
証明書を使用して manifest.json ファイルに署名し、signature というファイルに結果を書き込みます。
すべてを ZIP 圧縮し、結果として得られるファイルにファイル拡張子 .pkpass を付けます。

パスの署名には秘密キーが必要であるため、このプロセスは、制御下にあるセキュリティ保護されたサーバーでのみ行う必要があります。アプリケーションでパスを生成するためにキーを配布しないでください。

構成とセットアップ

このセクションでは、プロビジョニングの詳細を設定し、最初のパスを作成するための手順について説明します。

PassKit のプロビジョニング

パスを使って App Store に入るには、それを開発者アカウントにリンクする必要があります。これには、次の 2 つの手順が必要です。

パスは、Pass Type ID と呼ばれる一意の識別子を使用して登録する必要があります。
開発者のデジタル署名を使用してパスに署名するには、有効な証明書を生成する必要があります。

Pass Type ID を作成するには、次の操作を行います。

Pass Type ID を作成する

最初の手順では、サポートされるパスのタイプごとに Pass Type ID を設定します。 Pass ID (または Pass Type ID) は、パスの一意の識別子を作成します。この ID を使用し、証明書を使用してパスを開発者アカウントにリンクします。

iOS Provisioning Portal の [Certificates, Identifiers, and Profiles] セクションで、[Identifiers] に移動し、[Pass Type IDs] を選択します。次に、+ ボタンを選択して、新しいパスタイプを作成します。
パスの説明 (名前) と識別子 (一意の文字列) を指定します。すべての Pass Type ID は文字列 pass. で始まる必要があります。この例では、pass.com.xamarin.coupon.banana を使用します。
[Register] ボタンを押して、パス ID を確認します。

証明書を生成する

この Pass Type ID 用の新しい証明書を作成するには、次の操作を行います。

新しく作成したパス ID を一覧から選択し、[Edit] をクリックします。

次に、[Create Certificate…] を選択します。
証明書署名要求 (CSR) を作成する手順に従います。
開発者ポータルの [Continue] ボタンを押し、CSR をアップロードして証明書を生成します。
証明書をダウンロードし、それをダブルクリックしてキーチェーンにインストールします。

これで、Pass Type ID 用の証明書が作成されました。次のセクションでは、パスを手動で作成する方法について説明します。

ウォレットのプロビジョニングの詳細については、機能の使用に関するガイドを参照してください。

パスを手動で作成する

Pass Type を作成したので、シミュレーターまたはデバイスでテストするパスを手動で作成できます。パスを作成する手順は次のとおりです。

パスファイルを格納するディレクトリを作成します。
必要なすべてのデータを含む pass.json ファイルを作成します。
フォルダーにイメージを含めます (必要な場合)。
フォルダー内のすべてのファイルの SHA1 ハッシュを計算し、manifest.json に書き込みます。
ダウンロードした証明書 .p12 ファイルを使用して manifest.json に署名します。
ディレクトリの内容を ZIP 圧縮し、.pkpass という拡張子で名前を変更します。

この記事のサンプルコードには、パスの生成に使用できるソースファイルがいくつかあります。 CreateAPassManually ディレクトリの CouponBanana.raw ディレクトリにあるファイルを使用してください。次のファイルがあります。

pass.json を開き、JSON を編集します。 Apple Developer アカウントに合わせて、少なくとも passTypeIdentifier と teamIdentifer を更新する必要があります。

"passTypeIdentifier" : "pass.com.xamarin.coupon.banana",
"teamIdentifier" : "?????????",

その後、各ファイルのハッシュを計算し、manifest.json ファイルを作成する必要があります。最終的には次のようになるはずです。

{
  "icon@2x.png" : "30806547dcc6ee084a90210e2dc042d5d7d92a41",
  "icon.png" : "87e9ffb203beb2cce5de76113f8e9503aeab6ecc",
  "pass.json" : "c83cd1441c17ecc6c5911bae530d54500f57d9eb",
  "logo.png" : "b3cd8a488b0674ef4e7d941d5edbb4b5b0e6823f",
  "logo@2x.png" : "3ccd214765507f9eab7244acc54cc4ac733baf87"
}

次に、この Pass Type ID について生成された証明書 (.p12 ファイル) を使用して、このファイルの署名を生成する必要があります。

Mac 上で署名する

Apple ダウンロードサイトからウォレットシードのサポート資料をダウンロードしてください。 signpass ツールを使用して、フォルダーをパスに変換します (これにより、さらに SHA1 ハッシュが計算され、出力が .pkpass ファイルに ZIP 圧縮されます)。

テスト

これらのツールの出力を調べる (ファイル名を .zip に設定して開く) と、次のファイルが表示されます (manifest.json と signature ファイルが追加されている点に注意してください)。

署名、ZIP 圧縮、ファイル名の変更 (BananaCoupon.pkpass など) が完了したら、シミュレーターにドラッグしてテストするか、自分宛てにメールを送信して実際のデバイスで取得できます。次のように、パスを追加する画面が表示されます。

通常、このプロセスはサーバー上で自動化されますが、バックエンドサーバーのサポートを必要としない、クーポンのみを作成する小規模企業などは、手動でパスの作成を行うこともできます。

ウォレット

ウォレットは、PassKit エコシステムの中心的な部分です。以下のスクリーンショットは、空のウォレットのほか、パスリストと個々のパスの外観を示しています。

ウォレットの機能は次のとおりです。

ここは、スキャンするバーコードと一緒にパスがレンダリングされる唯一の場所です。
ユーザーは、設定を変更して更新できます。プッシュ通知 (有効な場合) によってパス内のデータが更新されます。
ユーザーは、ロック画面の統合を有効または無効にすることができます。有効にすると、パスに埋め込まれた関連する時刻と場所のデータに基づいて、パスがロック画面に自動的に表示されます。
パスの逆側では、web-server-URL がパス JSON で指定されている場合、「引っ張って更新」がサポートされます。
パス JSON でアプリの ID が指定されている場合は、コンパニオンアプリを開く (またはダウンロードする) ことができます。
パスは (細断を示すアニメーション付きで) 削除できます。

ウォレットにパスを追加する

パスは、次の方法でウォレットに追加できます。

コンジットアプリ - これらはパスを直接操作するのではなく、単にパスファイルをロードし、ウォレットに追加するオプションをユーザーに提示します。
コンパニオンアプリ - これらは、パスを配布し、それらを参照または編集するための追加機能を提供するためにプロバイダーによって記述されています。 Xamarin.iOS アプリケーションは、PassKit API に完全にアクセスしてパスを作成および操作できます。その後、PKAddPassesViewController 使用してパスをウォレットに追加できます。このプロセスの詳細については、このドキュメントの「コンパニオンアプリケーション」セクションを参照してください。

コンジットアプリケーション

コンジットアプリケーションは、ユーザーに代わってパスを受け取ることができる中間アプリです。これは、コンテンツタイプを認識し、ウォレットに追加する機能を提供するようにプログラミングする必要があります。コンジットアプリの例を次に示します。

メール - 添付ファイルをパスとして認識します。
Safari - パスの URL リンクがクリックされたときに、パスのコンテンツタイプを認識します。
その他のカスタムアプリ - 添付ファイルを受信したり、リンクを開いたりするアプリ (ソーシャルメディアクライアント、メールリーダーなど)。

このスクリーンショットは、iOS 6 のメールが、どのようにパスの添付ファイルを認識し、(タッチされたときに) 追加機能をウォレットに表示するかを示しています。

パスのコンジットになる可能性があるアプリを作成する場合は、次の方法で認識できます。

ファイル拡張子 - .pkpass
MIME タイプ - application/vnd.apple.pkpass
UTI - com.apple.pkpass

コンジットアプリケーションの基本的な操作は、パスファイルを取得し、PassKit の PKAddPassesViewController を呼び出して、ウォレットにパスを追加するオプションをユーザーに提供することです。このビューコントローラーの実装については、次の「コンパニオンアプリケーション」セクションで説明します。

コンジットアプリケーションは、コンパニオンアプリケーションのように、特定の Pass Type ID に対してプロビジョニングする必要はありません。

コンパニオンアプリケーション

コンパニオンアプリケーションには、パスの作成、Pass に関連付けられた情報の更新、アプリケーションに関連付けられているパスの管理など、パスを操作するための追加機能が用意されています。

コンパニオンアプリケーションで、ウォレットの機能を複製しないでください。これは、パスを表示してスキャンすることを目的とはしていません。

このセクションの残りの部分では、PassKit と対話する基本的なコンパニオンアプリを作成する方法について説明します。

プロビジョニング

ウォレットはストアテクノロジであるため、アプリケーションは個別にプロビジョニングする必要があり、Team Provisioning Profile や Wildcard App ID を使用することはできません。ウォレットアプリケーションの一意の App ID と Provisioning Profile を作成するには、機能の使用に関するガイドを参照してください。

権利

Entitlements.plist ファイルは、最近のすべての Xamarin.iOS プロジェクトに含める必要があります。新しい Entitlements.plist ファイルを追加するには、エンタイトルメントの使用に関するガイドの手順に従います。

エンタイトルメントを設定するには、次の操作を行います。

Visual Studio for Mac
Visual Studio

Solution Pad の Entitlements.plist ファイルをダブルクリックして、Entitlements.plist エディターを開きます。

Entitlements.plst editor

[Wallet] セクションで、[Enable Wallet] オプションを選択します。

Enable wallet entitlement

既定のオプションは、アプリですべてのパスタイプを許可することです。ただし、アプリを制限し、チームパスタイプのサブセットのみを許可することはできます。これを有効にするには、[Allow subset of team pass types] を選択し、許可するサブセットの Pass Type ID を入力します。

Entitlements.plist ファイルをダブルクリックして、XML ソースファイルを開きます。

ウォレットのエンタイトルメントを追加するには、ドロップダウンで [プロパティ] を Passbook Identifiers に設定します。これにより、タイプArray が自動的に設定されます。次に、文字列値を $(TeamIdentifierPrefix)* に設定します。

Enable wallet entitlement

これにより、アプリはすべてのパスの種類を許可できるようになります。アプリを制限し、チームパスタイプのサブセットのみを許可するには、文字列値を次に設定します。

$(TeamIdentifierPrefix)pass.$(CFBundleIdentifier)

ここで、pass.$(CFBundleIdentifier) は上で作成したパス ID です。

デバッグ

アプリケーションのデプロイで問題が発生した場合は、正しい Provisioning Profile を使用していること、[iPhone Bundle Signing] オプションで Entitlements.plist がカスタムエンタイトルメント ファイルとして選択されていることを確認してください。

デプロイ時にこのエラーが発生した場合:

Installation failed: Your code signing/provisioning profiles are not correctly configured (error: 0xe8008016)

この場合、pass-type-identifiers エンタイトルメント配列が間違っています (または Provisioning Profile と一致していません)。 Pass Type ID と Team ID が正しいことを確認します。

クラス

アプリからパスへのアクセスには、次の PassKit クラスを使用できます。

PKPass - パスのインスタンス。
PKPassLibrary - デバイス上のパスにアクセスするための API を提供します。
PKAddPassesViewController - ユーザーがウォレットに保存するパスを表示するために使用されます。
PKAddPassesViewControllerDelegate - Xamarin.iOS 開発者

例

この記事のサンプルコードにある PassLibrary プロジェクトを参照してください。これは、ウォレットコンパニオンアプリケーションで必要となる次の一般的な機能を示します。

ウォレットが使用可能であることを確認する

ウォレットは iPad では使用できないため、アプリケーションは PassKit 機能にアクセスする前に確認する必要があります。

if (PKPassLibrary.IsAvailable) {
    // create an instance and do stuff...
}

パスライブラリインスタンスを作成する

PassKit ライブラリはシングルトンではありません。アプリケーションは、PassKit API にアクセスするためのインスタンスを作成し、格納する必要があります。

if (PKPassLibrary.IsAvailable) {
    library = new PKPassLibrary ();
    // do stuff...
}

パスの一覧を取得する

アプリケーションは、ライブラリからパスの一覧を要求できます。この一覧は PassKit によって自動的にフィルター処理されるため、自分の Team ID で作成され、エンタイトルメントに一覧表示されているパスのみが表示されます。

var passes = library.GetPasses ();  // returns PKPass[]

シミュレーターでは返されるパスの一覧がフィルター処理されないため、この方法は、常に実際のデバイスでテストする必要があります。この一覧は UITableView に表示できます。サンプルアプリは、2 つのクーポンが追加された後、次のようになります。

パスを表示する

コンパニオンアプリ内でのパスのレンダリングでは、使用可能な一連の情報は限られています。

コード例で示すように、パスの一覧を表示するには、この一連の標準プロパティから選択します。

string passInfo =
                "Desc:" + pass.LocalizedDescription
                + "\nOrg:" + pass.OrganizationName
                + "\nID:" + pass.PassTypeIdentifier
                + "\nDate:" + pass.RelevantDate
                + "\nWSUrl:" + pass.WebServiceUrl
                + "\n#" + pass.SerialNumber
                + "\nPassUrl:" + pass.PassUrl;

この文字列は、サンプル内のアラートとして表示されます。

また、LocalizedValueForFieldKey() メソッドを使用して、設計したパス内のフィールドからデータを取得することもできます (どのフィールドがあるかがわかっているため)。これは、コード例には表示されません。

ファイルからパスを読み込む

パスはユーザーのアクセス許可があるウォレットにのみ追加できるため、ビューコントローラーを提示して決定できるようにする必要があります。このコードは、この例の [追加] ボタンで使用されています。これは、アプリに埋め込まれている事前構築済みのパスを読み込みます (これを署名したパスに置き換える必要があります)。

NSData nsdata;
using ( FileStream oStream = File.Open (newFilePath, FileMode.Open ) ) {
        nsdata = NSData.FromStream ( oStream );
}
var err = new NSError(new NSString("42"), -42);
var newPass = new PKPass(nsdata,out err);
var pkapvc = new PKAddPassesViewController(newPass);
NavigationController.PresentModalViewController (pkapvc, true);

パスには、[追加] と [キャンセル] オプションが表示されます。

既存のパスを置換する

既存のパスの置換には、ユーザーのアクセス許可は必要ありませんが、パスがまだない場合は失敗します。

if (library.Contains (newPass)) {
     library.Replace (newPass);
}

パスを編集する

PKPass は変更できないため、コード内の pass オブジェクトを更新することはできません。パス内のデータを変更するには、アプリケーションが、パスの記録を保持し、ダウンロードした更新値で新しいパスファイルを生成できる Web サーバーにアクセスできる必要があります。

パスは、非公開で安全な証明書を使用して署名する必要があるため、パスファイルの作成はサーバーで行う必要があります。

更新されたパスファイルが生成されたら、Replace メソッドを使用してデバイス上の以前のデータを上書きします。

スキャン用のパスを表示する

すでに説明したとおり、スキャン用のパスを表示できるのはウォレットのみです。パスは、次のように OpenUrl メソッドを使用して表示できます。

UIApplication.SharedApplication.OpenUrl (p.PassUrl);

変更の通知を受信する

アプリケーションは、PKPassLibraryDidChangeNotification を使用して、パスライブラリに加えられた変更をリッスンできます。変更は、バックグラウンドで更新をトリガーする通知によって発生する可能性があるため、アプリ上でリッスンすることをお勧めします。

noteCenter = NSNotificationCenter.DefaultCenter.AddObserver (PKPassLibrary.DidChangeNotification, (not) => {
    BeginInvokeOnMainThread (() => {
        new UIAlertView("Pass Library Changed", "Notification Received", null, "OK", null).Show();
        // refresh the list
        var passlist = library.GetPasses ();
        table.Source = new TableSource (passlist, library);
        table.ReloadData ();
    });
}, library);  // IMPORTANT: must pass the library in

PKPassLibrary はシングルトンではないため、通知に登録するときにはライブラリインスタンスを渡すことが重要です。

サーバー処理

PassKit をサポートするサーバーアプリケーションの作成の詳細については、この入門記事では説明しません。

dotnet-passbook オープンソース C# サーバーサイドコードを参照してください。

プッシュ通知

プッシュ通知を使用してパスを更新する方法の詳細については、この入門記事では説明しません。

更新が必要な場合は、Apple が定義する REST に似た API を実装して、ウォレットからの Web 要求に応答する必要があります。

詳細については、Apple のパスの更新に関するガイドを参照してください。

まとめ

この記事では、PassKit を紹介し、それが有用な理由をいくつか取り上げ、完全な PassKit ソリューションに実装する必要があるさまざまな要素について説明しました。 Apple Developer アカウントを構成してパスを作成するために必要な手順、パスを手動で作成するプロセス、Xamarin.iOS アプリケーションから PassKit API にアクセスする方法についても説明しました。

開発者向けのウォレット
PassKit のサンプル
ウォレット開発者ガイド
フレームワーク - Apple Pay とウォレット (WWDC ビデオ)
PassKit フレームワークリファレンス
Passbook Web サービスリファレンス
パスファイルについて
dotnet-passbook (iOS ウォレットパッケージを生成するためのオープンソースライブラリ)
iOS 6 の概要