Home

Introduction

The API handshake is a module that uses known security best practices to apply cryptography to any RESTFUL API. This allows for the creation of NodeJS API services that can be used to communicate with other clients that follow the protocol. This also provides the JavaScript based clients to communicate with other API Services using the same protocol.

Installation and Uses

The latest releases are found in NPM so to install, run the following

npm install adon-api-handshake --save

The module will contain 2 main classes. The HandshakeClient (for connecting to a server) and HandshakeServer (for API services).

const HandshakeServer = require('../index.js').HandshakeServer;
const HandshakeClient = require('../index.js').HandshakeClient;
const hs_server = new HandshakeServer();
const hs_client = new HandshakeClient();

HandshakeClient

The HandshakeClient allows us to perform requests to other services from the backend. this is useful for nodejs based backend processes or APIs that communicate to other secured APIs which utilize the protocol. for the complete guide please check out the HandshakeClient Guide.

HandshakeServer

The HandshakeServer enhances your restful service sessions by applying the cryptography protocol into it. for the complete guide please check out the HandshakeServerGuide