Access PassDock API methods for iOS 6 PassBook
Node.js module for PassDock API methods for iOS 6 PassBook.
API docs: https://api.passdock.com/doc
This module code and the consulting API are in an early development stage. The methods may produced unexpected results.
$ npm install passdock
var passdock = require'passdock'
$ git clone https://github.com/fvdm/nodejs-passdock
var passdock = require'/path/to/nodejs-passdock'
var passdock = require'passdock'passdockapitoken = 'your authentication token'passdocktemplateslist console.log
api.token is required to authenticate your API calls.
Each method takes a
callback function to process the result. This callback receives two parameters:
error. When an error occurs the
error param is an object and
result is the received unparsed text. When all is good
error is false and
result is the parsed JSON data.
error object may contain your API-key! Make sure this won't go public.
if errorconsole.log 'API trouble: '+ errorreasonelseconsole.log result
List all templates in your account.
Get one template identified with
passdocktemplatesshow 2309console.log templatetitle +' - '+ templatebarmessage
Delete a template
templateID from your account.
passdocktemplatesdelete 2309 console.log
List all passes using template
templateID in your account.
passdockpasseslist 2309 console.log
Get one pass for
passdockpassesshow 2309 123 console.log
Delete one pass with
passdockpassesdelete 2309 123 console.log
Create a new pass using
passObject can have these properties:
serial_number required The serial number for the Pass, must be unique and cannot be changed bar.message optional The message to be put in the code bar.altText optional The alternative text that will be put below the code For template keys (KEY = keyname): KEY.label optional The label for the field, usually placed above the value KEY.value optional The value of the field, usually placed below the label KEY.message optional The change message that will be shown in the lock screen and as notification when the value for the field is changed remotely
// KFC passvar pass =serial_number: 'helloWorld123'bar:message: ''Date:value: '29-12-2012'PROMOTION:value: 'blah'ADDRESS:label: 'Different'value: 'hello world'passdockpassescreate 2309 pass console.log
Update an existing pass
passID that is using
pass can have the same properties as in
passes.create, but only set the props you wish to change.
passdockpassesupdate 2309 432 bar: message: 'myapp://pass/123' console.log
This is free and unencumbered software released into the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
For more information, please refer to http://unlicense.org/