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

Supported Java version is 8+.

The generated code uses a few Maven dependencies e.g., Jackson, OkHttp, and Apache HttpClient. The reference to these dependencies is already added in the pom.xml file will be installed automatically. Therefore, you will need internet access for a successful build.

• In order to open the client library in Eclipse click on File -> Import.

• In the import dialog, select Existing Java Project and click Next.

• Browse to locate the folder containing the source code. Select the detected location of the project and click Finish.

• Upon successful import, the project will be automatically built by Eclipse after automatically resolving the dependencies.

• After successfully building the project, the client library needs to be installed as a Maven package in your local cache. Right-click on the project, select Show in Local Terminal -> Terminal or use Ctrl + Alt + T to open Terminal.

• In the terminal dialog, run the following command to install client library.

mvn install -Dmaven.test.skip=true -Dmaven.javadoc.skip=true

Installation

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

1. Starting a new project

For starting a new project, click the menu command File > New > Project.

Next, choose Maven > Maven Project and click Next.

Here, make sure to use the current workspace by choosing Use default Workspace location, as shown in the picture below and click Next.

Following this, select the quick start project type to create a simple project with an existing class and a main method. To do this, choose maven-archetype-quickstart item from the list and click Next.

In the last step, provide a Group Id and Artifact Id as shown in the picture below and click Finish.

2. Add reference of the library project

The created Maven project manages its dependencies using its pom.xml file. In order to add a dependency on the Akoya client library, double click on the pom.xml file in the Package Explorer. Opening the pom.xml file will render a graphical view on the canvas. Here, switch to the Dependencies tab and click the Add button as shown in the picture below.

Clicking the Add button will open a dialog where you need to specify Akoya in Group Id, akoya in Artifact Id and 2.4.0 in the Version fields. Once added click OK. Save the pom.xml file.

3. Write sample code

Once the SimpleConsoleApp is created, a file named App.java will be visible in the Package Explorer with a main method. This is the entry point for the execution of the created project. Here, you can add code to initialize the client library and instantiate a Controller class. Sample code to initialize the client library and using controller 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
httpClientConfig	Consumer<HttpClientConfiguration.Builder>	Set up Http Client Configuration instance.
loggingConfig	Consumer<ApiLoggingConfiguration.Builder>	Set up Logging Configuration instance.
authorizationCodeAuth	AuthorizationCodeAuth	The Credentials Setter for OAuth 2 Authorization Code Grant

The API client can be initialized as follows:

import com.akoya.ddp.sandboxproducts.AkoyaClient;
import com.akoya.ddp.sandboxproducts.Environment;
import com.akoya.ddp.sandboxproducts.authentication.AuthorizationCodeAuthModel;
import com.akoya.ddp.sandboxproducts.exceptions.ApiException;
import com.akoya.ddp.sandboxproducts.http.response.ApiResponse;
import com.akoya.ddp.sandboxproducts.models.OauthScope;
import com.akoya.ddp.sandboxproducts.models.OauthToken;
import java.io.IOException;
import java.util.Arrays;
import org.slf4j.event.Level;

AkoyaClient client = new AkoyaClient.Builder()
    .loggingConfig(builder -> builder
            .level(Level.DEBUG)
            .requestConfig(logConfigBuilder -> logConfigBuilder.body(true))
            .responseConfig(logConfigBuilder -> logConfigBuilder.headers(true)))
    .httpClientConfig(configBuilder -> configBuilder
            .timeout(0))
    .authorizationCodeAuth(new AuthorizationCodeAuthModel.Builder(
            "OAuthClientId",
            "OAuthClientSecret",
            "OAuthRedirectUri"
        )
        .oauthScopes(Arrays.asList(
                OauthScope.OPENID,
                OauthScope.PROFILE
            ))
        .build())
    .environment(Environment.SANDBOX)
    .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	-

Authorization

This API uses the following authentication schemes.

• acgAuth (OAuth 2 Authorization Code Grant)

List of APIs

• Accountinformation
• Tax Beta
• Balances
• Customers
• Investments
• Payments
• Statements
• Transactions

SDK Infrastructure

Configuration

• ApiLoggingConfiguration
• ApiLoggingConfiguration.Builder
• ApiRequestLoggingConfiguration.Builder
• ApiResponseLoggingConfiguration.Builder
• Configuration Interface
• HttpClientConfiguration
• HttpClientConfiguration.Builder

HTTP

• Headers
• HttpCallback Interface
• HttpContext
• HttpBodyRequest
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiResponse
• LinkPagedResponse
• PagedFlux
• PagedIterable
• PagedSupplier
• ApiHelper
• FileWrapper
• DateTimeHelper