Skip to content

Latest commit

 

History

History
55 lines (53 loc) · 3.18 KB

README.md

File metadata and controls

55 lines (53 loc) · 3.18 KB

Copyleaks PHP SDK

Copyleaks SDK is a simple framework that allows you to scan text for plagiarism and detect content distribution online, using the Copyleaks plagiarism checker cloud.

Using Copyleaks SDK you can detect plagiarism in:

Integration

Integrate with the Copyleaks SDK in one of two options:

  • Recommended: Use the Package Manager - Packagist.
    When integrating that way you will automatically be able to update the SDK to its latest version: 
    composer require copyleaks/php-plagiarism-checker @dev
    Following that, in order to use the SDK, add this to your code: 
    //copyleaks dependencies 
include_once( __DIR__.'/vendor/copyleaks/php-plagiarism-checker/autoload.php');
use Copyleaks\CopyleaksCloud;
use Copyleaks\CopyleaksProcess;
  • Download the code from this repository and add it to your project.

Register and Get Your API Key

To use the Copyleaks API you need to first have a Copyleaks account. The registration to Copyleaks takes a minute and is free of charge. Signup and confirm your account to finalize your registration.

You can generate your personal API key. Do so by entering your dashboard (Businesses dashboard/Academic dashboard/Websites dashboard), and under 'Access Keys' you will be able to see and generate your API keys.

For more information check out our API guide.

Example

Example.php will show you how to scan for plagiarism the URL: 'https://www.copyleaks.com'. All you have to do is to update the following two lines with your email and API key: 

$email = 'Your-Email-Address-Here';
$apiKey = 'Your-API-Key-Here';

This example shows how to scan a URL using the line:

 $process  = $clCloud->createByURL('https://www.copyleaks.com',$additionalHeaders);

You can change 'createByURL' with 'createByFile' to scan local files:

 $process = $clCloud->createByFile('./tests/test.txt',$additionalHeaders);

or with 'createByOCR to scan local images containing text:

$process  = $clCloud->createByOCR('./tests/c2253306-637a-44c3-8fe0-e0b5d237da32.jpg','English',$additionalHeaders);

Read More