ApimaticAkSDK 0.0.1

Getting Started with Akoya

Introduction

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

Akoya APIs include the following updates:

• 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.

Install the Package

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package ApimaticAkSDK --version 0.0.1

You can also view the package at: https://www.nuget.org/packages/ApimaticAkSDK/0.0.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

Code-Based Initialization

using Akoya.Standard;
using Akoya.Standard.Authentication;
using Microsoft.Extensions.Logging;

namespace ConsoleApp;

AkoyaClient client = new AkoyaClient.Builder()
    .BasicAuthCredentials(
        new BasicAuthModel.Builder(
            "Username",
            "Password"
        )
        .Build())
    .BearerAuthCredentials(
        new BearerAuthModel.Builder(
            "AccessToken"
        )
        .Build())
    .HttpClientConfig(httpClientConfig =>
        httpClientConfig.Timeout(TimeSpan.FromSeconds(100)))
    .Environment(Akoya.Standard.Environment.Production)
    .LoggingConfig(config => config
        .LogLevel(LogLevel.Information)
        .RequestConfig(reqConfig => reqConfig.Body(true))
        .ResponseConfig(respConfig => respConfig.Headers(true))
    )
    .Build();

Configuration-Based Initialization

using Akoya.Standard;
using Microsoft.Extensions.Configuration;

namespace ConsoleApp;

// Build the IConfiguration using .NET conventions (JSON, environment, etc.)
var configuration = new ConfigurationBuilder()
    .AddJsonFile("config.json")
    .AddEnvironmentVariables() // [optional] read environment variables
    .Build();

// Instantiate your SDK and configure it from IConfiguration
var client = AkoyaClient
    .FromConfiguration(configuration.GetSection("Akoya"));

See the Configuration-Based Initialization section for details.

Environments

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

Fields

Authorization

This API uses the following authentication schemes.

• basicAuth (Basic Authentication)
• bearerAuth (OAuth 2 Bearer token)

List of APIs

• Accountinformation
• Balances
• Customers
• Investments
• Payments
• Statements
• Transactions
• Tokens

SDK Infrastructure

Configuration

• Configuration-Based Initialization
• HttpClientConfiguration
• HttpClientConfigurationBuilder
• LogBuilder
• LogRequestBuilder
• LogResponseBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiResponse
• ApiHelper
• CustomDateTimeConverter
• UnixDateTimeConverter