cloudmersive/cloudmersive_virusscan_api_client

3.1.1 2023-12-11 03:57 UTC

Requires

• php: >=7.2.5
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/guzzle: ^7.5

Requires (Dev)

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

proprietary

• Cloudmersive

• php
• api
• sdk
• swagger

README

The Cloudmersive Virus Scan API lets you scan files and content for viruses and identify security issues with content.

Cloudmersive Virus Scan API provides advanced virus scanning capabilities.

• API version: v1
• Package version: 3.1.1

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_virusscan_api_client.git"
    }
  ],
  "require": {
    "cloudmersive/cloudmersive_virusscan_api_client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/cloudmersive_virusscan_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\ScanApi(
    // 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
);
$input_file = "/path/to/file.txt"; // \SplFileObject | Input file to perform the operation on.

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

?>

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
ScanApi	scanFile	POST /virus/scan/file	Scan a file for viruses
ScanApi	scanFileAdvanced	POST /virus/scan/file/advanced	Advanced Scan a file for viruses
ScanApi	scanWebsite	POST /virus/scan/website	Scan a website for malicious content and threats
ScanCloudStorageApi	scanCloudStorageScanAwsS3File	POST /virus/scan/cloud-storage/aws-s3/single	Scan an AWS S3 file for viruses
ScanCloudStorageApi	scanCloudStorageScanAwsS3FileAdvanced	POST /virus/scan/cloud-storage/aws-s3/single/advanced	Advanced Scan an AWS S3 file for viruses
ScanCloudStorageApi	scanCloudStorageScanAzureBlob	POST /virus/scan/cloud-storage/azure-blob/single	Scan an Azure Blob for viruses
ScanCloudStorageApi	scanCloudStorageScanAzureBlobAdvanced	POST /virus/scan/cloud-storage/azure-blob/single/advanced	Advanced Scan an Azure Blob for viruses
ScanCloudStorageApi	scanCloudStorageScanGcpStorageFile	POST /virus/scan/cloud-storage/gcp-storage/single	Scan an Google Cloud Platform (GCP) Storage file for viruses
ScanCloudStorageApi	scanCloudStorageScanGcpStorageFileAdvanced	POST /virus/scan/cloud-storage/gcp-storage/single/advanced	Advanced Scan an Google Cloud Platform (GCP) Storage file for viruses
ScanCloudStorageApi	scanCloudStorageScanSharePointOnlineFile	POST /virus/scan/cloud-storage/sharepoint-online/site/single	Virus Scan a file in a SharePoint Online Site Drive
ScanCloudStorageApi	scanCloudStorageScanSharePointOnlineFileAdvanced	POST /virus/scan/cloud-storage/sharepoint-online/site/advanced	Advanced Virus Scan a file in a SharePoint Online Site Drive

Documentation For Models

• AdditionalAdvancedScanInformation
• CloudStorageAdvancedVirusScanResult
• CloudStorageVirusFound
• CloudStorageVirusScanResult
• VirusFound
• VirusScanAdvancedResult
• VirusScanResult
• WebsiteScanRequest
• WebsiteScanResult

Documentation For Authorization

Apikey

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

Author