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 depends on a few Ruby gems. The references to these gems are added in the gemspec file. The easiest way to resolve the dependencies, build the gem and install it is through Rake:

1. Install Rake if not already installed: gem install rake
2. Install Bundler if not already installed: gem install bundler
3. From terminal/cmd navigate to the root directory of the SDK.
4. Invoke: rake install

Alternatively, you can build and install the gem manually:

1. From terminal/cmd navigate to the root directory of the SDK.
2. Run the build command: gem build akoya.gemspec
3. Run the install command: gem install akoya-2.4.0.gem

Installation

The following section explains how to use the akoya ruby gem in a new Rails project using RubyMine™. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

1. Starting a new project

Close any existing projects in RubyMine™ by selecting File -> Close Project. Next, click on Create New Project to create a new project from scratch.

Next, provide TestApp as the project name, choose Rails Application as the project type, and click OK.

In the next dialog make sure that the correct Ruby SDK is being used (>= 2.6 and <= 3.2) and click OK.

2. Add reference of the gem

In order to use the akoya gem in the new project we must add a gem reference. Locate the Gemfile in the Project Explorer window under the TestApp project node. The file contains references to all gems being used in the project. Here, add the reference to the library gem by adding the following line: gem 'akoya', '2.4.0'

3. Adding a new Rails Controller

Once the TestApp project is created, a folder named controllers will be visible in the Project Explorer under the following path: TestApp > app > controllers. Right click on this folder and select New -> Run Rails Generator....

Selecting the said option will popup a small window where the generator names are displayed. Here, select the controller template.

Next, a popup window will ask you for a Controller name and included Actions. For controller name provide Hello and include an action named Index and click OK.

A new controller class named HelloController will be created in a file named hello_controller.rb containing a method named Index.

1. Add the require 'akoya' statement to require the gem in the controller file.
2. Add the include Akoya statement to include the sdk module in the controller file.
3. In the Index method, add code for initialization and a sample for its usage.

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
connection	Faraday::Connection	The Faraday connection object passed by the SDK user for making requests
adapter	Faraday::Adapter	The Faraday adapter object passed by the SDK user for performing http requests
timeout	Float	The value to use for connection timeout. Default: 60
max_retries	Integer	The number of times to retry an endpoint call if it fails. Default: 0
retry_interval	Float	Pause in seconds between retries. Default: 1
backoff_factor	Float	The amount to multiply each successive retry's interval amount by in order to provide backoff. Default: 2
retry_statuses	Array	A list of HTTP statuses to retry. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array	A list of HTTP methods to retry. Default: %i[get put]
http_callback	HttpCallBack	The Http CallBack allows defining callables for pre and post API calls.
logging_configuration	LoggingConfiguration	The SDK logging configuration for API calls
authorization_code_auth_credentials	AuthorizationCodeAuthCredentials	The credential object for OAuth 2 Authorization Code Grant

The API client can be initialized as follows:

client = Akoya::Client.new(
  authorization_code_auth_credentials: AuthorizationCodeAuthCredentials.new(
    oauth_client_id: 'OAuthClientId',
    oauth_client_secret: 'OAuthClientSecret',
    oauth_redirect_uri: 'OAuthRedirectUri',
    oauth_scopes: [
      OauthScope::OPENID,
      OauthScope::PROFILE
    ]
  ),
  environment: Environment::SANDBOX,
  logging_configuration: LoggingConfiguration.new(
    log_level: Logger::INFO,
    request_logging_config: RequestLoggingConfiguration.new(
      log_body: true
    ),
    response_logging_config: ResponseLoggingConfiguration.new(
      log_headers: true
    )
  )
)

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

• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• PagedIterable
• LinkPagedResponse
• CursorPagedResponse
• OffsetPagedResponse
• NumberPagedResponse
• ApiHelper
• DateTimeHelper