https://github.com/fvdm/nodejs-passdock
PassDock API methods for iOS Wallet (PassBook)
https://github.com/fvdm/nodejs-passdock
api-client nodejs passbook unlicense wallet
Last synced: 6 months ago
JSON representation
PassDock API methods for iOS Wallet (PassBook)
- Host: GitHub
- URL: https://github.com/fvdm/nodejs-passdock
- Owner: fvdm
- License: unlicense
- Created: 2012-09-21T01:30:13.000Z (over 13 years ago)
- Default Branch: develop
- Last Pushed: 2025-04-05T19:53:00.000Z (9 months ago)
- Last Synced: 2025-05-27T13:05:36.993Z (8 months ago)
- Topics: api-client, nodejs, passbook, unlicense, wallet
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/passdock
- Size: 62.5 KB
- Stars: 13
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# nodejs-passdock
Node.js module for [PassDock](http://passdock.com/) API methods for iOS 6 PassBook.
API docs:
## BETA notice
This module code and the consulting API are in an early development stage.
The methods may produced unexpected results.
## Installation
`npm install passdock`
## Module usage
```js
const passdock = require( 'passdock' );
passdock.api.token = 'your authentication token';
passdock.templates.list( console.log );
```
`api.token` is required to authenticate your API calls.
## Methods
Each method takes a `callback` function to process the result.
This callback receives two parameters: `result` and `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.
**Warning:** the `error` object may contain your API-key!
Make sure this won't go public.
```js
function callback( result, error ) {
if( error ) {
console.log( `API trouble: ${error.reason}` );
} else {
console.log( result );
}
}
```
### Templates
#### templates.list ( callback )
List all templates in your account.
```js
passdock.templates.list( templates => {
templates.forEach( template => console.log( template.title ) );
} );
```
#### templates.show ( templateID, callback )
Get one template identified with `templateID`.
```js
passdock.templates.show( 2309, template => {
console.log( `${template.title} - ${template.bar.message}` )
} );
```
#### templates.delete ( templateID, callback )
Delete a template `templateID` from your account.
```js
passdock.templates.delete( 2309, console.log );
```
### Passes
#### passes.list ( templateID, callback )
List all passes using template `templateID` in your account.
```js
passdock.passes.list( 2309, console.log );
```
#### passes.show ( templateID, passID, callback )
Get one pass for `templateID` and `passID`.
```js
passdock.passes.show( 2309, 123, console.log );
```
#### passes.delete ( templateID, passID, callback )
Delete one pass with `passID` using `templateID`.
```js
passdock.passes.delete( 2309, 123, console.log );
```
#### passes.create ( templateID, passObject, callback )
Create a new pass using `templateID`.
`passObject` can have these properties:
property | description
+-----------------|+-----------
serial_number | The serial number for the Pass, must be unique and cannot be changed
[bar.message] | The message to be put in the code
[bar.altText] | The alternative text that will be put below the code
[KEYNAME.label] | The label for the field, usually placed above the value
[KEYNAME.value] | The value of the field, usually placed below the label
[KEYNAME.message] | The change message that will be shown in the lock screen and as notification when the value for the field is changed remotely
```js
// KFC pass
const pass = {
serial_number: 'helloWorld123',
bar: {
message: 'https://domain.tld/pass?id=123',
},
Date: {
value: '05-04-2025'
},
PROMOTION: {
value: 'blah'
},
ADDRESS: {
label: 'Different',
value: 'hello world'
}
}
passdock.passes.create( 2309, pass, console.log );
```
#### passes.update( templateID, passID, pass, callback )
Update an existing pass `passID` that is using `templateID`.
`pass` can have the same properties as in `passes.create`, but only set the props you wish to change.
```js
passdock.passes.update( 2309, 432, { bar: { message: 'myapp://pass/123' } }, console.log );
```
## Unlicense
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