1.0.5 • Published 9 years ago
yodlee v1.0.5
Yodlee API wrapper for node.
Installation
$ npm install --save yodlee
Usage
var yodlee = require('yodlee');
Authentication using Cobrand Credentials
Yodlee requires a cobSessionToken before we can access the API. Get your credentials here.
yodlee.use({
username: 'sbCobExampleAdminUser',
password: '96d621ec-2323-4664-b2fa-17ba6796b116'
});
OAuth Requests
Yodlee uses the standard oauth authentication flow in order to allow apps to act on a user's behalf. The API provides a convenience method to help you authenticate your users.
yodlee.getAccessToken({
username: 'sbMemsomeuser',
password: 'sbMemsomeuser#123'
})
.then(function(accessToken) {})
.catch(function(error) {});
Using the API
GET User Accounts
Returns the information related to the specified accounts aggregated by the User: Yodlee Docs
yodlee.getAccounts(accessToken)
.then(function(response) {})
.catch(function(error) {});
GET User Transactions
Executes a transaction search and returns the first page result: Yodlee Docs
yodlee.getTransactions(accessToken, {
containerType: 'All',
higherFetchLimit: 500,
lowerFetchLimit: 1,
resultRangeEndNumber: 60,
resultRangeStartNumber: 1,
searchFilterCurrencyCode: 'GBP',
ignoreUserInput: true
})
.then(function(response) {})
.catch(function(error) {});
Contributing
Unit tests
Unit test are written in Mocha. Please add a unit test for every new feature or bug fix. npm test
to run the test suite.
Documentation
Add documentation for every API change. Feel free to send corrections or better docs!
Pull Requests
Send fixes PR on the master
branch.
License
MIT © Craig Richardson