kross-sdk

For Installing

yarn add kross-sdk

OR

npm install kross-sdk

For Usage

API Client

import { KrossClient } from 'kross-sdk'

const client = new KrossClient({
  baseURL: 'https://da.kross.kr'
  accessId: 'youraccessid',
  secretKey: 'yoursecretkey',
  authToken: authToken,
  refreshToken: refreshToken,
  refreshTokenCallback: refreshTokenCallback,
});

KrossClient Params Description

Client Options Object

---

Clients Provided

KrossClient, Account, Loans, Investments, Inquiry, User, Verifications, GeneralInfo, SignContract

KrossClient : It is a base client through which you will be able to make requests any of the data providing APIs via axios instance.

Accounts : Contains functions and hooks through which you can make requests for account related data

Investments : Contains functions and hooks through which you can make requests for investments related data

Inquiry : Contains functions and hooks through which you can make requests for inquiries related data

User : Contains functions and hooks through which you can make requests for users related data

Loans : Contains functions and hooks through which you can make requests for loans related data

GeneralInfo : Contains functions and hooks through which you can make requests for generalInfo related public data such as articles, docs-terms, gets todays stats and loan statistics.

SignContract : Contains functions and hooks through which you can make requests for generating sign-contract document, getting sign-contract list per user and sign contract verification

---

Example of how to prepare clients for usage in real app

import {storage} from 'utils/storage';
import {envVariables} from './../constants/envVariables';
import {
  KrossClient,
  Loans,
  Investments,
  User,
  Account,
  Inquiry,
  GeneralInfo,
  SignContract,
} from 'kross-sdk';

export const useClients = () => {
  const authToken = storage.getString('authToken');
  const refreshToken = storage.getString('refreshToken');

  const refreshTokenCallback = (token: string) => {
    storage.set('authToken', token);
  };

  const clientOptions = {
    baseURL: baseURL,
    accessId: accessId,
    secretKey: secretKey,
    authToken: authToken,
    refreshToken: refreshToken,
    refreshTokenCallback: refreshTokenCallback,
  };
  const clients = {
    krossClient: new KrossClient(clientOptions),
    LoansClient: new Loans(clientOptions),
    InvestmentsClient: new Investments(clientOptions),
    UserClient: new User(clientOptions),
    AccountClient: new Account(clientOptions),
    InquiryClient: new Inquiry(clientOptions),
    GeneralInfoClient: new GeneralInfo(clientOptions),
    SignContract: new SignContract(clientOptions),
  };

  return clients;
};