yodlee-wrapper4.0.0 • Public • Published
Yodlee API wrapper for node. Forked from Craig Richardson's original repository: https://github.com/craigrich/yodlee
$ npm install --save yodlee
var yodlee = ;
Authentication using Cobrand Credentials & User Login
Yodlee requires a cobSessionToken before we can access the API. Get your credentials here. You can specify whether you wish to use the Sandbox API or the Live API when setting the Cobrand Credentials.
Yodlee uses the standard oauth authentication flow in order to allow apps to act on a user's behalf. Perform a login request to use the Yodlee API on behalf of a specific user after the Cobrand login step completes.
Accessing authentication tokens
The authentication tokens are cached in the application memory for 20 minutes after authentication by the steps above. The tokens should be accessed by the helper methods below. These methods will determine whether or not a new token is required based on the expiration timestamp stored in memory.
After performing a login you can access the session tokens using the helper methods below.
Note: When calling
getUserSessionToken the method will only require the username and password for the user if a new
userSessionToken is required. This is because a new login request will be performed against the Yodlee API.
Using the API
Once a user has successfully authenticated against the API the following methods can be used. Each method will determine which access tokens are required and only go to the Yodlee Auth API for new tokens when they have expired. Therefore, in most scenarios, a simple call to
login methods is required and the Yodlee Node library will take care of all other authentication decisions. The helper methods for access tokens above are only really useful if you wish to perform your own caching of the tokens in your application and need to access them for persistence purposes, or something similar.
GET All Site Accounts
Returns the information related to the specified accounts aggregated by the User: Yodlee Docs
GET Execute User Search
Executes a transaction search and returns the first page result: Yodlee Docs
GET Site Login Form
Returns the login form structure for a given Yodlee Site ID: Yodlee Docs
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.
Add documentation for every API change. Feel free to send corrections or better docs!
Send fixes PR on the
MIT © Craig Richardson