cloudmersive-security-api-client

CloudmersiveSecurityApiClient - JavaScript client for cloudmersive-security-api-client The security APIs help you detect and block security threats. Cloudmersive Security API helps you detect and block security threats.

• API version: v1
• Package version: 1.2.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-security-api-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-security-api-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('cloudmersive-security-api-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 CloudmersiveSecurityApiClient = require('cloudmersive-security-api-client');

var defaultClient = CloudmersiveSecurityApiClient.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 CloudmersiveSecurityApiClient.ContentThreatDetectionApi()

var value = "value_example"; // {String} User-facing text input.


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

Documentation for API Endpoints

All URIs are relative to https://api.cloudmersive.com

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- CloudmersiveSecurityApiClient.ContentThreatDetectionApi | contentThreatDetectionAutomaticThreatDetectionString | POST /security/threat-detection/content/automatic/detect/string | Automatically detect threats in an input string CloudmersiveSecurityApiClient.ContentThreatDetectionApi | contentThreatDetectionCheckSqlInjectionString | POST /security/threat-detection/content/sql-injection/detect/string | Check text input for SQL Injection (SQLI) attacks CloudmersiveSecurityApiClient.ContentThreatDetectionApi | contentThreatDetectionCheckXxe | POST /security/threat-detection/content/xxe/detect/xml/string | Protect text input from XML External Entity (XXE) attacks CloudmersiveSecurityApiClient.ContentThreatDetectionApi | contentThreatDetectionDetectInsecureDeserializationJsonString | POST /security/threat-detection/content/insecure-deserialization/json/detect/string | Detect Insecure Deserialization JSON (JID) attacks in a string CloudmersiveSecurityApiClient.ContentThreatDetectionApi | contentThreatDetectionProtectXss | POST /security/threat-detection/content/xss/detect/string | Protect text input from Cross-Site-Scripting (XSS) attacks through normalization CloudmersiveSecurityApiClient.NetworkThreatDetectionApi | networkThreatDetectionDetectSsrfUrl | POST /security/threat-detection/network/url/ssrf/detect | Check a URL for Server-side Request Forgery (SSRF) threats CloudmersiveSecurityApiClient.NetworkThreatDetectionApi | networkThreatDetectionIsBot | POST /security/threat-detection/network/ip/is-bot | Check if IP address is a Bot client threat CloudmersiveSecurityApiClient.NetworkThreatDetectionApi | networkThreatDetectionIsThreat | POST /security/threat-detection/network/ip/is-threat | Check if IP address is a known threat CloudmersiveSecurityApiClient.NetworkThreatDetectionApi | networkThreatDetectionIsTorNode | POST /security/threat-detection/network/ip/is-tor-node | Check if IP address is a Tor node server

Documentation for Models

• CloudmersiveSecurityApiClient.IPThreatDetectionResponse
• CloudmersiveSecurityApiClient.StringAutomaticThreatDetection
• CloudmersiveSecurityApiClient.StringInsecureDeserializationJsonDetection
• CloudmersiveSecurityApiClient.StringSqlInjectionDetectionResult
• CloudmersiveSecurityApiClient.StringXssProtectionResult
• CloudmersiveSecurityApiClient.StringXxeDetectionResult
• CloudmersiveSecurityApiClient.ThreatDetectionBotCheckResponse
• CloudmersiveSecurityApiClient.ThreatDetectionTorNodeResponse
• CloudmersiveSecurityApiClient.UrlSsrfThreatDetectionRequestFull
• CloudmersiveSecurityApiClient.UrlSsrfThreatDetectionResponseFull

Documentation for Authorization

Apikey

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