Passworks Android Wallet App API

This document describes how to use the Passworks Android Wallet API for

• Registering a Device to Receive Push Notifications for a Pass
• Sending Push Notifications to the Wallet App
• Installing Passworks Wallet and automatically install a pass after instalation

Getting started

Before using the Wallet API you need to contact Passworks Support via [email protected] asking for a API access key before staring using the API.

Registering a Device to Receive Push Notifications for a Pass

Passworks Wallet follows Apple's Wallet oficial API for registering a device for receiveing push notifications as stated in the following document

https://developer.apple.com/library/ios/documentation/PassKit/Reference/PassKit_WebService/WebService.html#//apple_ref/doc/uid/TP40011988-CH0-SW2

The major difference is that the Passworks Wallet App sends a custom HTTP header called X-Pass-Client with the value Passworks with each request.

If your system already implements the Apple Wallet (or Passbook) API you only need to take in account the new header flaging the registering device as and Android device using Passworks Wallet.

Sending Push Notifications to the Wallet App

Authentication

For authentication simply send the HTTP Authorization header with the Wallet API Key provided by Passworks support.

Authorization: <Wallet App Key>

The push notification request

Sending push notifications to Passworks Wallet API consists in sending a POST with a specific payload to the following Wallet App endpoint with the content type "application/json".

POST https://wallet.passworks.io/v1/pushUpdate

Payload [POST body content]:

{
	"passTypeIdentifier": "pass.io.passworks.public.generic",
	"pushTokens":[
	  "538156984fb963f2eccc92664f85876d72000923ea226e6befb8" ,
	  "7d633f073fa7c73750c62e6b0236423c99bb841527512fa6c0f0"
	]
}

Name	Type	Required	Description
passTypeIdentifier	String	Yes	The passTypeIdentifier eg: "pass.io.passworks.public.generic"
pushTokens	Array of Strings	Yes	Example: ["538156984fb963f2eccc92664f85876d72000923ea226e6befb8", "7d633f073fa7c73750c62e6b0236423c99bb841527512fa6c0f0"]

Successful response example, it's the raw Google Cloud Messaging response:

{
  "multicast_id": 6711075249753793221,
  "success": 1,
  "failure": 0,
  "canonical_ids": 0,
  "results": [
    {
      "message_id": "0:1448367205781799%4c47223ef9fd7ecd"
    }
  ]
}

Installing Passworks Wallet and automatically install a pass after instalation

When trying to server a Passbook (.pkpass) file to a client and if your client requires instalation of the Passworks Wallet App you can redirect him to the Wallet App Google Play Store page and specify a pass to be downloaded and installed automatily after instalation by passing the referrer parameter in the Google Play Store URL

GET https://play.google.com/store/apps/details?id=io.passworks.wallet&referrer={referrer}

Name	Type	Value	Description
referrer	String	eg: https://passworks.io/p/hello-passworks.pkpass	URL to the PKPASS file to be installed when the user first opens PassWorks Wallet App

To see how this works please remove all Passbook compatible apps and open the following URL in your Android Phone.

https://play.google.com/store/apps/details?id=io.passworks.wallet&referrer=https%3A%2F%2Fpassworks.io%2Fp%2Fhello-passworks.pkpass

NOTE: To avoid braking URL's please encode the referrer URL using URL encoding.

Help us make it better

Please tell us how we can make the Passworks Wallet API better. If you have a specific feature request or if you found a bug, please use GitHub issues. Fork these docs and send a pull request with improvements.

To talk with us and other developers about the API open a support ticket or mail us at [email protected] if you need to talk to us.

"Passbook" and "iOS" are registered trademarks of Apple Inc.
Passworks Passbook Wallet is not affiliated with Apple or Passbook/Wallet in any way.