Passbook とは

Passbook は iOS 6 から標準搭載アプリとなったチケット発行管理アプリです。

より分かりやすく説明するとライブのチケット、お店のクーポン、スーパーのポイントカード（他にもこんなものが管理できます）などを一つのアプリで管理できるというものです。
※Passbook ではこのアプリで管理できるチケットやクーポン、ポイントカードのことを Pass と呼びます。

この Pass には画像データとテキストデータが含まれており、テキストデータには位置情報が付記できます。 この位置情報を利用して、ライブ会場やファストフード店など近くを通ったときに、通知してくれるのです。  

Pass はアプリ内にあるので、財布から取り出し忘れることも、探す必要もなくなります。
（新たな問題として Pass から通知を受けたにも関わらずレジで見せ忘れる、何てことが発生しそうですねw）

更に、Passbook の仕様を見てみるとプッシュ通知に対応しており、各発行者がそれに対応していれば、最新の Pass データに自動で更新してくれます。

それでは Pass の中に触れていきます。

発行できる Pass の種類

※この表は Getting started with Passbook を適当に和訳したものです。

次にこれらのパスの配布方法です。

Passbook の作り方

Pass の配布方法

※この表は Getting started with Passbook を適当に和訳したものです。

E メールに添付する、Safari でダウンロードさせる際には MIME タイプを以下に設定しておく必要があります。

application/vnd.apple.pkpass

次にこれらのパスの中身についてです。

発行する Pass データの中身

Pass は .pkpass という拡張子で配布されます。

.pkpass ファイルはただの zip ファイルで、.pkpass の部分を .zip に書き換える、もしくはコマンドラインから unzip で解凍すれば中身をみることができます。

解凍した中身は以下のようになります。

***.pkpass
├ background.png
├ [email protected]
├ icon.png
├ [email protected]
├ logo.png
├ [email protected]
├ manifest.json
├ pass.json
├ signature
├ strip.png
├ [email protected]
├ thumbnail.png
└ [email protected]

何やら Chrome 拡張機能の crx ファイルのようです。

pass.json の中身が気になりますので、とりあえず Changing the Pass Type ID and Team ID に載っているサンプルを掲示します。

-- pass.json --
{
    "description" : "Coupon for a free lollipop at Example Candy Store",
    "logoText" : "Example Candy Store",
    "coupon" : {
        "primaryFields" : [
            {
                "key": "offer",
                "value": "Free lollipop"
                "label": "On July 29"
            }
        ]
    },
    "passTypeIdentifier" : "<<パスタイプ ID>>",
    "teamIdentifier" : "<<チーム ID>>",
}

参考資料「Passbookプログラミングガイド」の「パスタイプIDを要求する」のページをみると分かる通り、パスには Pass の種類を判別するための passTypeIdentifier（パスタイプ ID） とそれを管理する teamIdentifier（チーム ID） というのが必要なようです。

次はその ID を生成するのに必要な証明書の発行の仕方です。

Pass の作成に必要な項目と証明書の発行手順

passTypeIdentifier と teamIdentifier を得るために証明書を発行します。

パスタイプ ID と証明書生成

1. iOS Provisioning portal にアクセスし、New Pass Type ID から説明文とパスタイプ ID を入力してサブミットする
2. Pass Type IDs に移り、サブミットしたパスタイプ ID の証明書をダウンロードする
3. 証明書を Keychain Access で開き、キーチェーンに追加する

チーム ID の取得

1. Keychain Access を起動し、証明書を選択する
2. File » Get Info » Details » Organizational Unit » チーム ID

この パスタイプ ID と チーム ID を先程の pass.json に当てはめます。
とりあえず pass.json の上位ディレクトリーは demo.pass にしておきましょうかね。

./demo.pass
├ ~~~~~~~~
├ ~~~~~~~~
├ manifest.json
└ pass.json

signpass を利用してパスに署名を施し圧縮する

次に修正した pass ディレクトリー一式を署名・圧縮します。 signpass というツールを使うので Passbook SupportMaterials から入手してください。

この signpass を Terminal から実行します。
signpass のディレクトリーまで移動してから以下を実行します。

./signpass -p ~/demo.pass

これで demo.pkpass というファイルが出来ていれば成功です。

iOS Simulator で表示を確認する

このように表示されれば OK なようです。

ここまでの作業をサーバー上でやるには

この pkpass ファイルをサーバー上で動的に作るための PHP ライブラリーが既に公開されています。

この PHP-PassKit を使うことで簡単に pkpass が作れる予感がしてます。
※詳しくは README.md をご覧ください。

デバイスから最新の Pass データを取得する

エンドポイントはこのようにしなければならないようです。

              Protocol Version Number                        Serial Number
                         |                                         |
                        ---                                   ----------
ttps://example.com/hoge/v1/passes/pass.com.example.MyPassType/ABCDE12345
-----------------------           ---------------------------
           |                                   |
    Web Service URL                   Pass Type Identifier

パラメーター

最後に

以上、間違いなどあればご指摘いただければ幸いです。

参考資料

• Passbook for Developers - Apple Developer
• Passbookプログラミングガイド
• Getting started with Passbook
• 元記事

更新履歴

1. 「最後に」追記
2. MIME タイプ追記
3. 「デバイスから最新の Pass データを取得する」追記