Skip to content

Latest commit

 

History

History
193 lines (135 loc) · 10.2 KB

README.md

File metadata and controls

193 lines (135 loc) · 10.2 KB

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

You must have Python 3.7+ installed on your system to install and run this SDK. This SDK package depends on other Python packages like pytest, etc. These dependencies are defined in the requirements.txt file that comes with the SDK. To resolve these dependencies, you can use the PIP Dependency manager. Install it by following steps at https://pip.pypa.io/en/stable/installing/.

Python and PIP executables should be defined in your PATH. Open command prompt and type pip --version. This should display the version of the PIP Dependency Manager installed if your installation was successful and the paths are properly defined.

  • Using command line, navigate to the directory containing the generated files (including requirements.txt) for the SDK.
  • Run the command pip install -r requirements.txt. This should install all the required dependencies.

Building SDK - Step 1

Installation

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

1. Open Project in an IDE

Open up a Python IDE like PyCharm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

Open project in PyCharm - Step 1

Click on Open in PyCharm to browse to your generated SDK directory and then click OK.

Open project in PyCharm - Step 2

The project files will be displayed in the side bar as follows:

Open project in PyCharm - Step 3

2. Add a new Test Project

Create a new directory by right clicking on the solution name as shown below:

Add a new project in PyCharm - Step 1

Name the directory as "test".

Add a new project in PyCharm - Step 2

Add a python file to this project.

Add a new project in PyCharm - Step 3

Name it "testSDK".

Add a new project in PyCharm - Step 4

In your python file you will be required to import the generated python library using the following code lines

from akoya.akoya_client import AkoyaClient

Add a new project in PyCharm - Step 5

After this you can write code to instantiate an API client object, get a controller object and make API calls. Sample code is given in the subsequent sections.

3. Run the Test Project

To run the file within your test project, right click on your Python file inside your Test project and click on Run

Run Test Project - Step 1

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
http_client_instance HttpClient The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 60
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ['GET', 'PUT']
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 = AkoyaClient(
    authorization_code_auth_credentials=AuthorizationCodeAuthCredentials(
        oauth_client_id='OAuthClientId',
        oauth_client_secret='OAuthClientSecret',
        oauth_redirect_uri='OAuthRedirectUri',
        oauth_scopes=[
            OauthScope.OPENID,
            OauthScope.PROFILE
        ]
    ),
    environment=Environment.SANDBOX,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            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.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities