1.0.0 • Published 7 years ago

freee-node v1.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
7 years ago

freee API Client for Node.js

freeeの公開APIのnode.js用クライアントです。ただし現時点ではAuthorization Code Flowのみに対応しています

APIドキュメント

freeeのAPIのドキュメントはこちらを参照してください

Install

npm install freee-node --save

Usage

var Freee = require('freee-node')
var freee = new Freee({
    clientId: CLIENT_ID,
    clientSecret: CLIENT_SECRET,
    redirectUri: CALLBACK_URI
});

access token保存まで

expressを利用したWebサーバで、authorization codeを取得するためにURLにリダイレクトするケースと、access tokenを取得する方法についてのサンプルコードです。oauth2の処理はjs-client-oauth2のライブラリに大きく依存しています。

app.get('/freee', function(req, res) {
    //認可コード取得用のURLに遷移する
    res.redirect(freee.getUri())
})
app.get('/freee/callback', function(req, res) {
    //認可コードからアクセストークンを取得する
    freee.getToken(req.originalUrl).then(function(token) {
        // token.accessTokenやtoken.refreshTokenを保存する
    })
})

freee APIを利用する

freee.api.get('/api/1/users/me', {companies: true}).then(function(res) {
    console.log(res)
})
freee.api.get('/api/1/account_items', {company_id: company_id}).then(function(res) {
    console.log(res)
})
freee.api.post('/api/1/items', {
    company_id: company_id,
    name: 'ひんもーく',
    shortcut1: 'hnmk',
    shortcut2: 'hinmoku'
}).then(function(res) {
    console.log(res)
})

Licence

MIT

Author

ymzkmct