cloudmersive/cloudmersive_security_api_client

1.2.0 2021-07-18 07:36 UTC

Requires

• php: >=5.5
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ~1.12
• phpunit/phpunit: ^4.8
• squizlabs/php_codesniffer: ~2.6

proprietary

• Cloudmersive

• php
• api
• sdk
• swagger

README

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

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/cloudmersive/cloudmersive_security_api_client.git"
    }
  ],
  "require": {
    "cloudmersive/cloudmersive_security_api_client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/cloudmersive_security_api_client/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Apikey', 'Bearer');

$apiInstance = new Swagger\Client\Api\ContentThreatDetectionApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$value = "value_example"; // string | User-facing text input.

try {
    $result = $apiInstance->contentThreatDetectionAutomaticThreatDetectionString($value);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentThreatDetectionApi->contentThreatDetectionAutomaticThreatDetectionString: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

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

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

Documentation For Models

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

Documentation For Authorization

Apikey

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

Author