Geezeo.SDK.Aggregation 2.0.0.9

Geezeo .net SDK

Geezeo Software Developers Kit for the Geezeo Platform API for Microsoft .net 4.5.2 and above.

Overview

The Geezeo .net SDK accelorates FI's integrating the Geezeo platform API's into their .net solutions. The Geezeo SDK covers the entire platform except aggregation.

Benefits

The SDK provides

• Concrete class for Aggregate API endpoints (both async and synchronous calls)
• Data entities representing the Aggregate API reguest / response messages.

Getting started

Getting started is easy. Either clone/fork this project and build it yourself, or install via nuget.

Install-Package Geezeo.SDK.Aggregation 

Help docs

We are expanding our API docs to include details on the .net SDK. For now, here are some samples to get started.

Create the SDK

There are 2 ways to initilaize the SDK:

Passing in the API Key, Hostname, and User Id

var sdk = new SDK(apiKey, hostName, userId);

If you would like to use Json Web Tokens (JWT) you can also pass in your Partner Id

var sdk = new SDK(apiKey, hostName, userId, partnerId);

You can also control the time to live (TTL) in seconds of Json Web Tokens by passing in additional parameter as a string (default is "3600")

var sdk = new SDK(apiKey, hostName, userId, partnerId, ttl);

You are also able to set all parameters via an configuration file

var sdk = new SDK(userId);

Here is the config sample:

 <appSettings>
        <add key="ApiKey" value="KEY GOES HERE" />
        <add key="HostName" value="HOST GOES HERE" />		
</appSettings>

If you want to use JWT then will need to add your Partner Id as well.

 <appSettings>
        <add key="ApiKey" value="KEY GOES HERE" />
        <add key="HostName" value="HOST GOES HERE" />
		<add key="PartnerId" value="PARTNER ID GOES HERE" />
</appSettings>

You can also control the time to live (TTL) for all Json Web Tokens by adding this setting to your config file

 <appSettings>
		<add key="timeToLive" value="VALUE IN SECONDS GOES HERE" />
</appSettings>

Examples

Get a list of institutions

var sdk = new SDK(userId);
var institutions = sdk.Aggregation.GetFeaturedInstitutions();

Get a list of institutions and do not use JWT

var sdk = new SDK(userId);
sdk.ClearJWT();
var institutions = sdk.Aggregation.GetFeaturedInstitutions();

Get a list of accounts and update them where necessary

var sdk = new SDK(userId);
var accounts = sdk.Aggregation.GetAllAccounts();
foreach (var account in accounts.Items) {
    if (account.NeedsToBeUpdated) {        
        var prompt = sdk.Aggregation.GetUpdateAuthPrompt(account);
        Dictionary<string,string> newCredentials = {
            {"parameterId1","value1"},
            {"parameterId2","value2"}
        };

        sdk.Aggregation.UpdateAuthentication(prompt, newCredentials);
    }
}