lithammer / passbook_flask_example

An example Implementation of a Passbook Webservice in Flask, based on mattt's passbook_rails_example

Passbook on Flask Example

Passbook is an iOS 6 feature that manages boarding passes, movie tickets, retail coupons, & loyalty cards. Using the PassKit API, developers can register web services to automatically update content on the pass, such as gate changes on a boarding pass, or adding credit to a loyalty card.

Apple provides a specification for a REST-style web service protocol to communicate with Passbook, with endpoints to get the latest version of a pass, register / unregister devices to receive push notifications for a pass, and query for passes registered for a device.

This project is an example implementation of this web service specification in Flask.

Apple recently updated their Developer Program License Agreement, so if you have an active developer account, but cannot access the links to PassKit documentation, make sure that you've accepted the new terms. You can accept the new terms on the main page of the iOS Member Center.

Requirements

• Python 2.5+
• PostgreSQL 9.1 running locally (Postgres.app is the easiest way to get a Postgres server running on your Mac)

Getting Started

$ git clone https://github.com/lithammer/passbook_flask_example.git passbook
$ cd passbook
$ python app.py

Deployment

Heroku is the easiest way to get your app up and running. For full instructions on how to get started, check out "Getting Started with Python on Heroku".

Once you've installed the Heroku Toolbelt, and have a Heroku account, enter the following commands from the project directory:

$ heroku create
$ git push heroku master

Take the URL from your newly-created Heroku app, and specify that as the webservice URL for your Passbook bundle.

---

Specification

What follows is a summary of the specification. The complete specification can be found in the Passbook Web Service Reference.

Getting the Latest Version of a Pass

GET http://example.com/passes/<pass_type_identifier>/<serial_number>

• pass_type_identifier The pass’s type, as specified in the pass.
• serial_number The unique pass identifier, as specified in the pass.

Response

• If request is authorized, return HTTP status 200 with a payload of the pass data.
• If the request is not authorized, return HTTP status 401.
• Otherwise, return the appropriate standard HTTP status.

Getting the Serial Numbers for Passes Associated with a Device

GET http://example.com/devices/<device_library_identifier>/registrations/<pass_type_identifier>[?passesUpdatedSince=tag]

• device_library_identifier A unique identifier that is used to identify and authenticate the device.
• pass_type_identifier The pass’s type, as specified in the pass.
• serial_number The unique pass identifier, as specified in the pass.
• passesUpdatedSince (optional) A tag from a previous request.

Response

If the passesUpdatedSince parameter is present, return only the passes that have been updated since the time indicated by tag. Otherwise, return all passes.

• If there are matching passes, return HTTP status 200 with a JSON dictionary with the following keys and values:
  • last_updated (string) The current modification tag.
  • serial_numbers (array of strings) The serial numbers of the matching passes.
• If there are no matching passes, return HTTP status 204.
• Otherwise, return the appropriate standard HTTP status.

Registering a Device to Receive Push Notifications for a Pass

POST http://example.com/devices/<device_library_identifier>/registrations/<pass_type_identifier>/<serial_number>

• device_library_identifier A unique identifier that is used to identify and authenticate the device.
• pass_type_identifier The pass’s type, as specified in the pass.
• serial_number The unique pass identifier, as specified in the pass.

The POST payload is a JSON dictionary, containing a single key and value:

• push_token The push token that the server can use to send push notifications to this device.

Response

• If the serial number is already registered for this device, return HTTP status 200.
• If registration succeeds, return HTTP status 201.
• If the request is not authorized, return HTTP status 401.
• Otherwise, return the appropriate standard HTTP status.

Unregistering a Device

DELETE http://example.com/devices/<device_library_identifier>/registrations/<pass_type_identifier>/<serial_number>

• device_library_identifier A unique identifier that is used to identify and authenticate the device.
• pass_type_identifier The pass’s type, as specified in the pass.
• serial_number The unique pass identifier, as specified in the pass.

Response

• If disassociation succeeds, return HTTP status 200.
• If the request is not authorized, return HTTP status 401.
• Otherwise, return the appropriate standard HTTP status.

---

Contact

Peter Lithammer

• http://github.com/lithammer

License

passbook_flask_example is available under the MIT license. See the LICENSE file for more info.

passbook_flask_example's Issues

Conform to PEP8.

Mostly related to lines longer than 80 characters.

$ flake8 app.py 
app.py:61:80: E501 line too long (84 characters)
app.py:89:80: E501 line too long (87 characters)
app.py:95:80: E501 line too long (106 characters)
app.py:104:80: E501 line too long (86 characters)
app.py:106:80: E501 line too long (86 characters)
app.py:108:80: E501 line too long (85 characters)
app.py:112:80: E501 line too long (89 characters)
app.py:117:80: E501 line too long (103 characters)
app.py:118:80: E501 line too long (93 characters)
app.py:123:80: E501 line too long (106 characters)
app.py:130:80: E501 line too long (98 characters)
app.py:139:80: E501 line too long (87 characters)
app.py:140:80: E501 line too long (81 characters)
app.py:145:80: E501 line too long (106 characters)
app.py:149:80: E501 line too long (86 characters)
app.py:150:80: E501 line too long (113 characters)

Add onupdate function for updated_at fields.