Passbook Methods – Integration API’s

Passbook API

Creating a Pass

This method is used to create a Pass destined for passbook. The output of this method is a signed .pkpass file which when displayed to the consumer will allow the ability to store this pass within their Apple Wallet.

POSThttps://pass.kouponmedia.com/create/authKey/identity/offerId

POST Body Options

Parameter Required/Optional Description
authKey required Authentication Key assigned to a Client.
identity required Unique identifier string for Consumer device/app.
offerId required Offer Id to create a Pass for.
latitude optional Latitude of location to find nearby stores. Both latitude and longitude are required for this option.
longitude required Longitude of location to find nearby stores. Both latitude and longitude are required for this option.
radius optional Mobile phone number of the consumer.
limit optional Limit of the number of nearby stores to find.
barcode optional A string representing a scanned barcode value.
pin optional A string representing a PIN for the barcode.
cardBalance optional A number representing a gift card balance (e.g. 25, 12.50).

Example Request Body

    
{ 
  "barcode" : "barcode_value",  
  "pin" : "pin_value",  
  "cardBalance" : balance_value  
}

Example Response

    
application/vnd.apple.pkpass  //signed Pass