data-grid-surface v1.2.0

DATA-GRID-SURFACE

JavaScript SDK which communicates with data-grid API service. It uses the API service and it's end-points to determine if the given emails or passwords have been compromised.

Installation

Install SDK using npm

npm install data-grid-surface

Using data-grid-surface sdk

When you import the data-grid-surface package, you import the DataGrid class.

DataGrid class methods:

DataGrid methods returns Promise objects as a response.

NOTE: Passwords and emails are hashed with SHA256 algorithm before being sent to the API service.

You can pass raw email/password or its hashed value. If you are passing hashed value you need to hash it with SHA256 algorithm and encode it in base64 format.

checkEmail()

Parameters:

• email \<String>
• isHashed \<Boolean> default value is true

Returns:

• \<Promise>

checkPassword()

Parameters:

• password \<String>
• isHashed \<Boolean> default value is true

Returns:

• \<Promise>

checkPhoneNumber()

Parameters:

• phoneNumber \<String>
• isHashed \<Boolean> default value is true

Returns:

• \<Promise>

Use example:

DataGrid class constructor expects an object with your data-grid-api credentials

const DataGrid = require('data-grid-surface');

const dataGrid = new DataGrid({ 
    username: <datagridapiusername>, 
    password: <datagridapipassword>
});

dataGrid.checkEmail('email@example.com', false)
.then(response => {
    ...
}).catch(err => {
    ...
});

dataGrid.checkPassword('passwordexample', false)
.then(response => {
    ...
}).catch(err => {
    ...
});

dataGrid.checkPhoneNumber('+38164....', false)
.then(response => {
    ...
}).catch(err => {
    ...
});

Response:

{ 
    status: 'success', 
    data: { 
        exposed: true|false,
        breach_source: 'facebook'
    } 
}