ivalt-api-js

iValt API

iValt Api - JavaScript client for accessing iValt Biometric Authentication APIs. Identify Anyone, From Anywhere for Any Application. See this npm package in action at https://ondemandid.com

• API version: 1.0
• Package version: 1.0

Installation

npm

Install the repo by running the command:

npm install ivalt-api-js --save

Running in a Browser-based App

Webpack Configuration

Follow these steps to compile ivalt-api-js into a single JavaScript file for use in a website.

Create working dir

Create the working directory.

mkdir ivalt-api-js
cd ivalt-api-js
mkdir dist

Init npm & install webpack

Prepare npm, install webpack and a couple of libraries needed for running webpack.

npm init --yes
npm install webpack
npm install webpack-cli
npm install path
npm install querystring

Install ivalt-api-js

npm install ivalt-api-js

Add webpack.config.js

Create the webpack configuration file that defines the location of your main entry file and desired output directory for the generated file. Example:

const path = require('path');
    module.exports = {
      entry: './main.js',                        <-- YOUR JAVASCRIPT FILE THAT WILL BE CALLING IVALT
      output: {
        path: path.resolve(__dirname, 'dist'),   <-- TARGET PATH FOR THE SINGLE JAVASCRIPT FILE
        filename: 'ivalt-api.js'                 <-- NAME OF THE SINGLE JAVASCRIPT FILE
      },
      resolve: {
        alias: {
          'node_modules': path.join(__dirname, 'node_modules'),
        }
      }
    };

add main.js

Update the entry attribute in the webpack.config.js to point to your main JS file. Here is a sample if you do not have one yet. Example:

var IValtApi = require('ivalt-api-js');
var defaultClient = IValtApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"

var api = new IValtApi.DefaultApi()
var mobile = "your number"; // {String}

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

api.biometricAuthRequest(mobile, callback);

Run webpack

Run webpack to generate the single file. Example:

npx webpack 

Getting Started

Now that you have installed via npm and possible as a single JavaScript file for a browser. Follow these steps to use the API.

Get an API Key

iValt APIs require a client api key. You may request a key by sending a request on our contact form: https://ivalt.com/contact-us.php

Get Coding

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

var IValtApi = require('ivalt-api-js');
var defaultClient = IValtApi.ApiClient.instance;

// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"


var api = new IValtApi.DefaultApi()
var mobile = "phone-number"; // {String} 

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

API Endpoints

All URIs are relative to https://api.ivalt.com

Class	Method	HTTP request	Description
IValtApi.DefaultApi	[biometricAuthRequest]	POST /biometric-auth-request	Initiate a biometric auth request
IValtApi.DefaultApi	[biometricResultRequest]	POST /biometric-auth-result	Results of a biometric auth request
IValtApi.DefaultApi	[webCardBiometricAuthRequest]	POST /webcard-biometric-auth-request	Initiate a biometric auth request for webcard users
IValtApi.DefaultApi	[webCardBiometricResultRequest]	POST /webcard-biometric-auth-result	Results of a biometric auth request for webcard users

Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: X-API-KEY
• Location: HTTP header