Akoya_apis_v2 NPM

akoya_apis_v2

AkoyaApisV2 - JavaScript client for akoya_apis_v2 Akoya APIs for data recipients including token, data access, and transaction endpoints. Default servers are set to override for the Akoya sandbox environment. This SDK is automatically generated by the Swagger Codegen project:

API version: 2.0
Package version: 2.0
Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen For more information, please visit http://www.akoya.com

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install akoya_apis_v2 --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var AkoyaApisV2 = require('akoya_apis_v2');
var defaultClient = AkoyaApisV2.ApiClient.instance;


var api = new AkoyaApisV2.AkoyaProductsApi()
var version = "version_example"; // {String} Akoya product version
var providerId = "providerId_example"; // {String} End-user's data provider

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.customerInfo(version, providerId, callback);

Documentation for API Endpoints

All URIs are relative to https://sandbox-products.ddp.akoya.com

Class	Method	HTTP request	Description
AkoyaApisV2.AkoyaProductsApi	customerInfo	GET /customers/{version}/{providerId}/current	Customer info
AkoyaApisV2.AkoyaProductsApi	getAccounts	GET /accounts/{version}/{providerId}	Investments
AkoyaApisV2.AkoyaProductsApi	getAccountsInfo	GET /accounts-info/{version}/{providerId}	Account information
AkoyaApisV2.AkoyaProductsApi	getBalances	GET /balances/{version}/{providerId}	Balances
AkoyaApisV2.AkoyaProductsApi	getTransactions	GET /transactions/{version}/{providerId}/{accountId}	Transactions
AkoyaApisV2.AkoyaProductsApi	paymentNetworks	GET /payments/{version}/{providerId}/{accountId}/payment-networks	Payments

Documentation for Models

Documentation for Authorization

basicAuth

Type: HTTP basic authentication

bearerAuth

@babel/cli superagent

@everything-registry/sub-chunk-1113

2.0.0

1 year ago