PassKit

FREE
By passkit
Updated 4 months ago
Commerce
1.6/10
Popularity Score
350ms
Latency
50%
Success Rate

PassKit API Documentation

PassKit: Create, Distribute and Manage Apple Passbook Passes. PassKit is a set of tool and methods that allow businesses and developers quickly, easily and affordably design, create, distribute, update, analyse and manage content for Apple Passbook. PassKit helps you and your business at every step of the Passbook Pass Lifecycle.

API to access PassKit.

  1. Create passkit API account;
  2. Goto: https://api.passkit.com/v1/mashape/{mashape username};
  3. Authenticate with API KEY and SECRET; - pairs mashape with PassKit account
View API Details
Image methods
GETGet Image Data
POSTUpload Image
GETUpload Image (by URL)
Admin methods
GETAuthenticate
Template methods
GETGet Passes For Template
GETGet Template Field Names
GETGet Template Field Names (full)
GETList Templates
POSTReset Template
PUTUpdate Template
Pass methods
GETGet Pass Details (by template and serial)
GETGet Pass Details (by pass id)
GETGet Unique Pass Id (by share id)
POSTInvalidate Pass (by pass id)
POSTInvalidate Pass (by template name and serial)
PUTIssue Pass
PUTIssue Pass (Batch)
PUTUpdate Pass (by template name & serial)
PUTUpdate pass (by pass id)
GETGet Image Data

This method returns data about a particular imageID, specifically te useage types that it has been processed for. More info at: https://code.google.com/p/passkit/wiki/GetImageData

Header Parameters
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
Required Parameters
imageidSTRING
REQUIREDThe image ID
Code Snippet
unirest.get("https://passkit-passkit.p.rapidapi.com/image/o3G18zTo94lU8Ubdd2RUp")
.header("X-RapidAPI-Host", "passkit-passkit.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
Sample Response
General
Request URL: https://passkit-passkit.p.rapidapi.com/image/{imageID}
Request Method: GET
Response Headers
Response Body

Install SDK for NodeJS

Installing

To utilize unirest for node.js install the the npm module:

$ npm install unirest

After installing the npm package you can now start simplifying requests like so:

var unirest = require('unirest');

Creating Request

unirest.get("https://passkit-passkit.p.rapidapi.com/image/o3G18zTo94lU8Ubdd2RUp")
.header("X-RapidAPI-Host", "passkit-passkit.p.rapidapi.com")
.header("X-RapidAPI-Key", "SIGN-UP-FOR-KEY")
.end(function (result) {
  console.log(result.status, result.headers, result.body);
});
OAuth2 Authentication
Client ID
Client Secret
OAuth2 Authentication