Getting Started with Akoya APIs v2.4.0

Introduction

Akoya product APIs for data access. Default servers are set for the Akoya sandbox environment.

Akoya APIs include the following updates:

v2.4.0
- Added Tax product
v2.3.0
- Removed erroneous accountId query param from Taxlots endpoint
- Added TaxLots endpoint
v2.2.2
- Added mode query parameter to Account Information, Balances, Investments, and Transactions to support standard mode.
- Edited callouts for Account Holder endpoint
v2.2.1
- Fixed typo in accountIds query parameter for /accounts-info, /balances, /accounts
- Added security method for Account holder information to bear token. Missing method defaulted to basic auth.
- Added examples and descriptions to some schemas
- Added HTTP status 429 FDX error 1207.
v2.2 Additions
- Added optional x-akoya-interaction-type header to all endpoints to specify if a request is part of a batch process
- Update of tags to organize endpoints by Akoya product
- 206 response added to /accounts-info, /balances, /accounts
v2.1 New Statements product and Customers product updated with additional endpoint, Account holder information.
v2.0 Launch of Akoya products: Account Info, Balances, Investments, Transactions, Payments, Customers.

Building

The generated code uses the Newtonsoft Json.NET NuGet Package. If the automatic NuGet package restore is enabled, these dependencies will be installed automatically. Therefore, you will need internet access for build.

Open the solution (Akoya.sln) file.

Invoke the build process using Ctrl + Shift + B shortcut key or using the Build menu as shown below.

The build process generates a portable class library, which can be used like a normal class library. More information on how to use can be found at the MSDN Portable Class Libraries documentation.

The supported version is .NET Standard 2.0. For checking compatibility of your .NET implementation with the generated library, click here.

Installation

The following section explains how to use the Akoya.Standard library in a new project.

1. Starting a new project

For starting a new project, right click on the current solution from the solution explorer and choose Add -> New Project.

Next, choose Console Application, provide TestConsoleProject as the project name and click OK.

2. Set as startup project

The new console project is the entry point for the eventual execution. This requires us to set the TestConsoleProject as the start-up project. To do this, right-click on the TestConsoleProject and choose Set as StartUp Project form the context menu.

3. Add reference of the library project

In order to use the Akoya.Standard library in the new project, first we must add a project reference to the TestConsoleProject. First, right click on the References node in the solution explorer and click Add Reference...

Next, a window will be displayed where we must set the checkbox on Akoya.Standard and click OK. By doing this, we have added a reference of the Akoya.Standard project into the new TestConsoleProject.

4. Write sample code

Once the TestConsoleProject is created, a file named Program.cs will be visible in the solution explorer with an empty Main method. This is the entry point for the execution of the entire solution. Here, you can add code to initialize the client library and acquire the instance of a Api class. Sample code to initialize the client library and using Api methods is given in the subsequent sections.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
Environment	`Environment`	The API environment. Default: `Environment.Sandbox`
Timeout	`TimeSpan`	Http client timeout. Default: `TimeSpan.FromSeconds(100)`
HttpClientConfiguration	`Action<HttpClientConfiguration.Builder>`	Action delegate that configures the HTTP client by using the HttpClientConfiguration.Builder for customizing API call settings. Default: `new HttpClient()`
LogBuilder	`LogBuilder`	Represents the logging configuration builder for API calls
AuthorizationCodeAuth	`AuthorizationCodeAuth`	The Credentials Setter for OAuth 2 Authorization Code Grant

The API client can be initialized as follows:

using Akoya.Standard;
using Akoya.Standard.Authentication;
using Akoya.Standard.Models;
using Microsoft.Extensions.Logging;
using System.Collections.Generic;

AkoyaClient client = new AkoyaClient.Builder()
    .AuthorizationCodeAuth(
        new AuthorizationCodeAuthModel.Builder(
            "OAuthClientId",
            "OAuthClientSecret",
            "OAuthRedirectUri"
        )
        .OauthScopes(
            new List<OauthScope>
            {
                OauthScope.Openid,
                OauthScope.Profile,
            })
        .Build())
    .Environment(Akoya.Standard.Environment.Sandbox)
    .LoggingConfig(config => config
        .LogLevel(LogLevel.Information)
        .RequestConfig(reqConfig => reqConfig.Body(true))
        .ResponseConfig(respConfig => respConfig.Headers(true))
    )
    .Build();

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name	Description
Sandbox	Default
Production	-

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Getting Started with Akoya APIs v2.4.0

Introduction

Building