Zaim.js

Node.js library for the Zaim API.

##Install Install from npm:

$ npm install zaim

##Usage Please see API doc for further details.

###Constructor

var Zaim = require('zaim');

var zaim = new Zaim({
  // must configure consumer key and secret
  consumerKey: 'CONSUMER KEY',
  consumerSecret: 'CONSUMER SECRET',
  // option params
  accessToken: 'ACCESS TOKEN',
  accessTokenSecret: 'ACCESS TOKEN SECRET',
  callback: 'CALLBACK URL'
});

###Authorization url

zaim.getAuthorizationUrl(function(url) {
  // https://www.zaim.net/users/auth?oauth_token=***
  console.log(url);
});

###Get access token and Secret

zaim.getOAuthAccessToken(pin, function(err, token, secret, results) {
  console.log(token); //access token
  console.log(secret); //access token secret
});

###Set access token and secret

zaim.setAccessToken('accessToken');
zaim.setAccessTokenSecret('accessTokenSecret');

###User

zaim.getCredentials(function(data) {
  console.log(data);
});

###Create payment

zaim.createPay({
  category_id: 'category_id', //required
  genre_id: 'genre_id', //required
  price: 100, //required
  date: '2013-04-10',
  comment: 'comment: memo (within 100 characters)',
  active: 'public or private（0:private 1:public, default is 0）'
}, function(data){
  console.log(data);
});

###Create income

zaim.createIncome({
  category_id: 'category_id', //required
  price: 100, //required
  date: '2013-04-10',
  comment: 'comment: memo (within 100 characters)',
  active: 'public or private（0:private 1:public, default is 0）'
}, function(data){
  console.log(data);
});

###Get money

zaim.getMoney({
  category_id: 'narrow down by category_id',
  genre_id: 'narrow down by genre_id',
  type: 'narrow down by type (pay or income)',
  order: 'sort by id or date (default : date)',
  start_date: 'the first date (Y-m-d format)',
  end_date: 'the last date (Y-m-d format)',
  page: 'number of current page (default 1)',
  limit: 'number of items per page (default 20, max 100)'
}, function(data, err) {
  console.log(data);
});

or

zaim.getMoney(function(data) {
  console.log(data);
});

###Get payment categories

zaim.getPayCategories({
  lang: 'If you set this parameter with "ja", response title becomes Japanese.'
}, function(data) {
  console.log(data);
});

or

zaim.getPayCategories(function(data) {
  console.log(data);
});

###Get income categories

zaim.getIncomeCategories({
  lang: 'If you set this parameter with "ja", response title becomes Japanese.'
}, function(data) {
  console.log(data);
});

or

zaim.getIncomeCategories(function(data) {
  console.log(data);
});

###Get payment genres

zaim.getPayGenres({
  lang: 'If you set this parameter with "ja", response title becomes Japanese.'
}, function(data) {
  console.log(data);
});

or

zaim.getPayGenres(function(data) {
  console.log(data);
});

###Get currencies

zaim.getCurrencies(function(data) {
  console.log(data);
});

##Test

$ npm install && mocha

Release note

• 2013/04/09 0.0.1 release.
• 2013/05/05 0.0.9 release.
• 2013/05/10 1.0.0 release.

##Link

• Zaim API doc
• GitHub Pages