smart_otp_sdk

SmartOtpSdk - JavaScript client for smart_otp_sdk SmartOTP API Specs for Payment This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0.0
Package version: 1.0.0
Build package: io.swagger.codegen.languages.JavascriptClientCodegen

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 smart_otp_sdk --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your smart_otp_sdk from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('smart_otp_sdk') in javascript files from the directory you ran the last command above from.

git

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

    npm install YOUR_USERNAME/smart_otp_sdk --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, that's to say your javascript file where you actually use this library):

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:

POST /register-smart-otp

const registerApi = new SmartOtpSdk.RegisterApi();

var registerBody = new SmartOtpSdk.RegisterOtpRequestModel();
registerBody.activationCode = 'MK2ZKQ';
registerBody.transId = 22;
registerBody.pin = '1234';

var callback = function (error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log(
      'API called successfully. Returned data: ' + JSON.stringify(data),
    );
  }
};
registerApi.registerSmartOtp(registerBody, callback);

GET /get-totp-code

var SmartOtpSdk = require('smart_otp_sdk');

var totpApi = new SmartOtpSdk.TotpApi();

var pin = '1234'; // {String} PIN of user set for token

var callback = function (error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('totpApi called successfully. Returned data: ' + data);
  }
};
totpApi.getTotpCode(pin, callback);

GET /get-ocra-otp

var SmartOtpSdk = require('smart_otp_sdk');

var api = new SmartOtpSdk.OcraApi();

var pin = 'pin_example'; // {String} PIN of user set for token

var challenge = 'challenge_example'; // {String} challenge code

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

Documentation for API Endpoints

All URIs are relative to http://api.vnptpay.vn/v1

Class	Method	HTTP request	Description
SmartOtpSdk.OcraApi	generateOtpOcra	GET /get-ocra-otp	Get user OTP code on SDK
SmartOtpSdk.RegisterApi	registerSmartOtp	POST /register-smart-otp	Register SmartOTP on a device
SmartOtpSdk.TotpApi	getTotpCode	GET /get-totp-code	Get user OTP code on SDK

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

thinhnpptit/smart-otp-js-sdk