Yodlee API Tutorial For Android

WHAT IS YODLEE?

Yodlee is a British software company that develops an account aggregation service that allows users to see their credit card, bank, investment, email, travel reward accounts, etc. on one screen. In addition, Yodlee Labs (formerly Yodlee MoneyCenter), a free web application that helps consumers their finances online, provides features such as bill payment, expense tracking, and investment management.

APIs PROVIDED BY YODLEE

  • Account Aggregation APIs

  • Account Verification APIs

  • Credit Risk API

STEPS FOR INTEGRATING YODLEE API IN ANDROID

STEP-1: Create Developer Account

Register yourself on yodlee’s official website and then login into your account. After logging in, you’ll see your API Dashboard.

In the API Keys and Sandbox Connection Details section, your cobrandlogin and cobrandpassword would be mentioned. These credentials will be used to authenticate the android device from which you are trying to access Yodlee API.

Next section is API Versions and End-Points in which you’ll see Yodlee API URL and Yodlee FastLink Node URL. The last URL Yodlee Wrapper APIs (REST/SOAP) is deprecated. The Yodlee API URL is used to authenticate the device and the users. Fastlink Node URL is used to launch the Yodlee’s Fastlink Application.

Yodlee provides 5 test users which can be used for testing in the staging environment.

STEP-2: Cobrand Login

Let’s dive in to the API resources provided by Yodlee and see how Cobrand Login works. For this, go to the below section and enter your developer credentials and click on set auth tokens button. Cobrand token and user token will be generated. The user token is generated automatically by using the credentials of the first test users from your API Dashboard.

1

Now. move on to the cobrand section and click on /{cobrandName}/v1/cobrand/login (POST). In the Parameters section, enter your cobrand credentials in the cobrandParam field in the below JSON format and click on Try Out.

{
 "cobrand": {
 "cobrandLogin": "XXXXX",
 "cobrandPassword": "XXXXX-XXX-XXXXX-XXXXX",
 "locale": "en_US"
                   }
}

For getting the cobrandLogin and cobrandPassword go to the API Dashboard.

COBRAND OUTPUT

2

We can also test this by using Postman tool.

1

STEP-3: User Registration

We need to register the end users with Yodlee in order to gain access to their bank accounts. The registration URL in the Yodlee API reference cannot be used to register end users. You’ll be able to register users only in your specific sandbox and production environment.

STEP-4: User Login

For user login, the cobrand session generated in response has to be passed as a header while making a request to user login URL. The below parameter should be supplied in the body.

{
  "user": {
  "loginName": "<username>",
  "password": "<userpassword>",
  "locale": "en_US"
  }
 }

SAMPLE REQUEST – RESPONSE

Request

21

Response

3

STEP-5: Get Access Token

Generate access token for launching Yodlee Fastlink. cobSession and userSession has to passed as Authorization in the header.

Header

Authorization: cobSession=08062013_2:c18ca6f58abbb962363d0ea90fb292493b78f93665f6741efcfb2deb1c83c36a2394ebbf7429f5ab1877ed8b1a512a5e1319531d3c4e5b3b2166080306b8985d,userSession=08062013_1:07275f4640ca096a383d60b8d5a6188d7fbafb80b71179fc3ec88f4eb95d9df9de44ad10fda9094a739b5d634f42b3220d9caac38a852aa4c06e33ad0be6689e

Request – Response

4

STEP-6: Launch Fastlink

Use the following html page to launch yodlee fastlink in your web/mobile webview:

<div class=’center processText’>Processing…</div>
<div>
<form action=’https://node.developer.yodlee.com/authenticate/restserver/’ method=’post’ id=’rsessionPost’>
RSession : <input type=’text’ name=’rsession’ placeholder=’rsession’ value=” id=’rsession’/><br/>
FinappId : <input type=’text’ name=’app’ placeholder=’FinappId’ value=’10003600′ id=’finappId’/><br/>
Redirect : <input type=’text’ name=’redirectReq’ placeholder=’true/false’ value=’true’/><br/>
Token : <input type=’text’ name=’token’ placeholder=’token’ value=” id=’token’/><br/>
Extra Params : <input type=’text’ name=’extraParams’ placeholer=’Extra Params’ value=’callback=http://google.co.in’ id=’extraParams’/><br/>
</form>
</div>
<button onclick=”document.getElementById(‘rsessionPost’).submit()”>LAUNCH FASTLINK</button>

In the above html page, we need to pass the below values:

  1.  userSession in the value for Rsession.
  2. accessToken generated in the last step in the value for Token.
  3. The callback URL is used to redirect the user to the URL given in the value for ExtraParams.

With all the above things followed correctly, we should be able to launch Fastlink. Save the html page and launch it.

6

 

STEP-7: Getting account information

After user adds his/her account, we can get the information about the account added by making a GET request to the URL(https://developer.api.yodlee.com:443/ysl/restserver/v1/accounts). Pass the cobSession and userSession as Authorization header and make a GET request as shown below.

Sample Request-Response

1

STEP-8: Getting transactions

For retreiving all the transactions of the accounts added by the user, we need to make a GET request to the URL(https://developer.api.yodlee.com:443/ysl/restserver/v1/transactions). Again, cobSession and userSession has to passed as Authorization header. Remember that cobSession and userSession is valid only for 100  and 30 minutes respectively. So, if you are gettting “Invalid token in Authorization header” you need to regenerate both cobSession and userSession again and pass it in the header. By default, this request will show the transaction of the last 30 days. We can also pass a date range in the parameter.

Sample Request-Response

1




admin Author

Leave a Reply

Your email address will not be published. Required fields are marked *