gridy-js-client

Installation

For Node.js

npm

Install it via:

npm install gridy_client --save

Finally, you need to build the module:

npm run build

Local development

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

To use the link you just defined in your project, switch to the directory you want to use your gridy_client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

Get it from the our git repository, e.g.https://github.com/gridy.io/gridy-js-client then install it via:

    npm install gridy.io/gridy-client-nodejs --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:

JS

var GridyIdApi = require('gridy_client');
var defaultClient = GridyIdApi.ApiClient.instance;
var api = new GridyIdApi.GridyIDServiceApi()

var apiRequest = { 
 "id":< Your own reference >,
 "utctime": <UTC Timestamp>,
 "apiUser":< Your Api User ID >,
 "type":150,
 "body":{
   "gridyUser":"<User Email Address>",
   "challengeType":<"UserKeyAndPattern"|"UserKeyPatternAndPin"|"UserKeyAndUserPin"|"UserKeyAndUserFace"|"UserKeyAndUserVoice" >,
   "challengeExpiry":<"ThreeMins"|"FiveMins"|"TenMins"|"FifteenMins"|"ThirtyMins"|"SixtyMins">,
   "enableQRCode":<true|false>,
   "enableAutoVerify":<true|false>,
   "profile":"<Your Assigned User Profile Reference>",
   "status":"NEW"
 }
}; // {ApiRequest} The JSON body of the request. Contains the Gridy ID challenge request.

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

api.challenge(apiRequest, callback);

Documentation & Examples for API Endpoints

All URIs are relative to https://api.gridy.io

Class	Method	HTTP request	Description
GridyIdServiceApi	challenge	POST /v1/svc/challenge	Send or Cancel a Gridy ID MFA challenge request.
GridyIdServiceApi	verify	POST /v1/svc/verify	Verify a Gridy ID authentication code
GridyIdServiceApi	status	POST /v1/svc/status	Check a Gridy ID MFA challenge status
GridyIdServiceApi	time	POST /v1/svc/time	Get current UTC time
GridyIdServiceApi	blocked	POST /v1/svc/blocked	Check API User defined Blocked Rule