cloudmersive-dlpapi-client

CloudmersiveDlpapiClient - JavaScript client for cloudmersive-dlpapi-client Easily and directly scan and detect sensitive data (PII) in input text. Cloudmersive DLP API allows you to scan input for Personally Identifiable Information (PII), Personal Health Information (PHI), Personal Financial Information and other types of sensitive data. Advanced AI is used to both detect and redact with next-generation accuracy.

• API version: v1
• Package version: 2.0.0

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install cloudmersive-dlpapi-client --save

Local development

To use the library locally without publishing to a remote npm registry, first 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

Finally, switch to the directory you want to use your cloudmersive-dlpapi-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('cloudmersive-dlpapi-client') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --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, that's to say your javascript file where you actually use this library):

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:

var CloudmersiveDlpapiClient = require('cloudmersive-dlpapi-client');

var defaultClient = CloudmersiveDlpapiClient.ApiClient.instance;

// Configure API key authorization: Apikey
var Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix['Apikey'] = "Token"

var api = new CloudmersiveDlpapiClient.DetectApi()

var opts = { 
  'body': new CloudmersiveDlpapiClient.DlpDocumentDetectionRequest() // {DlpDocumentDetectionRequest} Input request
};

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

Documentation for API Endpoints

All URIs are relative to https://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- CloudmersiveDlpapiClient.DetectApi | detectDocument | POST /dlp/detect/document | Detect User Data in Document Image CloudmersiveDlpapiClient.DetectApi | detectDocumentAdvanced | POST /dlp/detect/document/advanced | Detect User Data in Document Image (Advanced) CloudmersiveDlpapiClient.DetectApi | detectText | POST /dlp/detect/text | Detect User Data in Input Text CloudmersiveDlpapiClient.DetectApi | detectTextAdvanced | POST /dlp/detect/text/advanced | Detect User Data in Input Text (Advanced) CloudmersiveDlpapiClient.RedactApi | redactDocument | POST /dlp/redact/document | Redact User Data in Document CloudmersiveDlpapiClient.RedactApi | redactDocumentAdvanced | POST /dlp/redact/document/advanced | Redact User Data in Document (Advanced) CloudmersiveDlpapiClient.RedactApi | redactText | POST /dlp/redact/text | Redact User Data in Input Text CloudmersiveDlpapiClient.RedactApi | redactTextAdvanced | POST /dlp/redact/text/advanced | Redact User Data in Input Text (Advanced)

Documentation for Models

• CloudmersiveDlpapiClient.DlpAdvancedDetectionRequest
• CloudmersiveDlpapiClient.DlpAdvancedDetectionResponse
• CloudmersiveDlpapiClient.DlpAdvancedDocumentDetectionRequest
• CloudmersiveDlpapiClient.DlpAdvancedDocumentRedactionRequest
• CloudmersiveDlpapiClient.DlpAdvancedDocumentRedactionResponse
• CloudmersiveDlpapiClient.DlpAdvancedRedactionRequest
• CloudmersiveDlpapiClient.DlpAdvancedRedactionResponse
• CloudmersiveDlpapiClient.DlpDetectionRequest
• CloudmersiveDlpapiClient.DlpDetectionResponse
• CloudmersiveDlpapiClient.DlpDocumentDetectionRequest
• CloudmersiveDlpapiClient.DlpDocumentRedactionRequest
• CloudmersiveDlpapiClient.DlpDocumentRedactionResponse
• CloudmersiveDlpapiClient.DlpRedactionRequest
• CloudmersiveDlpapiClient.DlpRedactionResponse
• CloudmersiveDlpapiClient.RedactedPageInfo

Documentation for Authorization

Apikey

• Type: API key
• API key parameter name: Apikey
• Location: HTTP header