Client SDK

This is a wrapper to call the apis from Finnotech, note that this client only works with Client_Credential type services.

Installation

You can install this package with the following command:

npm i finnotech-client-sdk

Create a new client

You can create a new client with the following code:

import {ClientSDK} from "./ClientSDK";

const clientSDK = new ClientSDK(); 

You should configure .env file before using client:

# Client Configuration
CLIENT_NID=""
CLIENT_ID=""
CLIENT_PASSWORD=""

# Redis Configuration
REDIS_HOST="localhost"
REDIS_PORT="6379"

# Logger Configuration
LOG_PATH="/var/tmp/ClientSDK.log"

# Set this to true if you want to use sandbox address
USE_SANDBOX=false

# Set this to true if you are developing clientSDK
DEVELOPMENT=false

CLIENT_ID Is the client id which you get from Finnotech, in applications section.
CLIENT_PASSWORD Is the client password which you get from Finnotech, in applications section.
CLIENT_NID Is the client national id

Call cc services

You can call a CLIENT-CREDENTIAL service with callService method:

const response = await clientSDK.callService(serviceName, payload);

serviceName is the name of the service which you want to call, and it should be in config.yaml file.
payload is the payload which you want to send to the service.

Call services by refresh code

You can call CLIENT-CREDENTIAL or CODE services with callServiceByRefreshToken method:

const response = await clientSDK.callServiceByRefreshToken(serviceName, payload, refreshToken);

Docker

To run the project in docker, you can use the following command:

docker-compose up --build

This command will build the images and run your index.ts file and all the tests.

For stopping the docker, you can use the following command:

docker-compose down

Example

import {ClientSDK} from "./ClientSDK";
import {v4 as uuid} from 'uuid';

// Create a new client, use redis from localhost
const clientSDK = new ClientSDK();

const result = await clientSDK.callService('billingInquiry', {
    trackId: uuid(),
    type: "Tel",
    parameter: "021xxxxxxx1",
    secondParameter: "MCI"
})

console.log(result);

Resulting output should look like:

{
    status: 200,
    data: {
        responseCode: 'FN-BGVH-20000000000',
        trackId: 'de8d92dd-e6fd-4dee-b61b-1a80d1a771dd',
        result: {
            Amount: '1195000',
            BillId: '89xxxxxxx48',
            PayId: '1xxxxxxx9',
            Date: '',
        },
        status: 'DONE',
    } ,
}

Testing

To test the client, you can use following command:

npm run test

Client sdk tests are in ClientSDK.spec.ts file.

Note: If you did not pass redisUrl to the client, Be sure that you have redis installed and running on redis://localhost:6379.

Logging

Configure log path: LOG_PATH in .env file.

# Logger Configuration
LOG_PATH="/var/tmp/ClientSDK.log"