@qb/shield-connector v2.0.0

SHIELDSQUARE-CONNECTOR

Official ShieldSquare NodeJs Connector.

Version: 2.0.0

Supports

• Node.js version (>= 0.10.25)
• This connector architects on top of express middleware concept, so this can be used only with express servers.

How do I get set up?

Shield Square Supports two modes of connection,

• Monitor Mode
• Active Mode

The connector supports both of the them out of the box.

NOTE: Set the configurations in ss2_config.js file. To run sample files(sample_active.js and sample_monitor.js) you have to run "npm install" command in the Sample Pages folder and also in the root folder of the NodeJs Connector.

ss2_config.js

Path: Sample Pages/ss2_config.js module.exports = { Monitor: { _sid: "your_sid", _mode: "Monitor", _sessid: 'connect.sid', _ss2_domain: 'ss_sa.shieldsquare.net', httpProxy: false, timeout: 100, _deployment_number: 1234, debug: false, _domain_ttl: 3600, // in-seconds _domain_cache_file: 'cachefilepath' }, Active: { _sid: "your_sid", _mode: "Active", _sessid: 'connect.sid', _ss2_domain: 'ss_sa.shieldsquare.net', httpProxy: false, timeout: 100, _deployment_number: 1234, debug: false, _domain_ttl: 3600, // in-seconds _domain_cache_file: 'cachefilepath' }, ReCaptcha: { secret: 'your_recaptcha_secret_key', public: 'your_recaptcha_public_key' } }

Note: Please update default configuration present in lib/configuration/manifest.js

Calltype & UserId Params

userid : If userId is not present then keep it as empty string.

calltype :

1 -> for a normal page request 2 -> for a form submit 6 -> for a mobile APP

7 -> for a feature phone

Both the values are taken as query string parameter.

For Ex: http://localhost:3000?calltype=2&userId=12345

Contribution guidelines

• JSLint for linting

NOTE: To run sample files you have to run "npm install" command in the Sample Pages folder and the root folder of the NodeJs Connector.