cloudmersive/cloudmersive_dlp_api_client

3.0.2 2026-02-22 23:43 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

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: 3.0.2

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/cloudmersive_dlp_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\DetectApi(
    // 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
);
$body = new \Swagger\Client\Model\DlpDocumentDetectionRequest(); // \Swagger\Client\Model\DlpDocumentDetectionRequest | Input request

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

?>

Documentation for API Endpoints

All URIs are relative to https://localhost

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

Documentation For Models

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

Documentation For Authorization

Apikey

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

Author