impact-seo/killduplicate-api-php

PHP Example Library to use KillDuplicate API

dev-master 2021-08-26 14:00 UTC

Requires

• php: >=5.3.0

MIT

• Hugo Maugey

• content
• duplicate

README

PHP Example Library to use KillDuplicate API

Install this library

composer require impact-seo/killduplicate-api-php=dev-master

or download and uncompress archive

Set config.php

• Copy your API Key (connect to your account and go to API -> settings)
• Set Your API Callback. (If you installed package via composer, it should look something like http://www.your-website.com/vendor/impact-seo/killduplicate-api-php/api_callback.php)
• Give results folder write permissions (webserver user's ownership. www-data for Ubuntu, apache ...)
• Go to www.yourwebsite.com/vendor/impact-seo/killduplicate-api-php/index.php if you installed through composer or adapt path to where you extracted lib.

API Specifications

Get your remaining credits

GET /api/public/credits/api_key

Params

api_key = Your Private API Key # required

Returns

credits

Get scan cost (before running it for instance)

POST /api/public/price

Params

api_key = Your Private API Key # required
text = Your Text (UTF-8 encoded) # required

Scan Text

POST /api/public/scan

Params

api_key = Your Private API Key # required
text = Your Text (UTF-8 encoded) # required
exclude_domains = Array of excluded domain names from duplicate search # optional
callback = Your callback url # required
format = desired return format # optional - possible values : json|xml - default : json 

Returns Immediate response

text_id : store this id for retrieving result in callback
credits : how much credits this scan has cost

Callback Response

{
    "id": "82",
    "resume": "Demain, d\u00e8s l'aube, \u00e0 l'heure o\u00f9 blanchit la ca",
    "filename": null,
    "credits": "1",
    "date": "2016-04-01 16:41:43",
    "callback": "http:\/\/www.your-website.com\/vendor\/impact-seo\/killduplicate-api-php\/api_callback.php",
    "format": "json",
    "result": "long",
    "duplicate": "0",
    "dup_percentage": "0",
    "text": null,
    "exclude_domains": {},
    "search_dupes": {
        "1692": {
            "id": "1692",
            "text_id": "82",
            "phrase": "Demain, d\u00e8s l'aube, \u00e0 l'heure o\u00f9 blanchit la",
            "search_dupe_results": []
        },
        ...
    },
    "search_dupe_results": [],
    "phrases_to_check": "11",
    "phrases_checked": 11,
    "results": []
}

Get Scan

If for some reason, previous callback function is not send from our servers or not received by yours, you can force a call to retrieve specific scan status. To know if a scan has finished, you have to compare phrases_to_check against phrases_checked parameters. We stongly advise you to set up a callback function and use this call only to retrieve lost results.

GET /api/public/scan/API_KEY/SCAN_ID

Params

API_KEY = Your Private API Key # required
SCAN_ID = Your scan id # required

Returns Immediate response similar to callback response

Errors

Possible error messages

UNKWONW_API_KEY : check your API key is corectly set in config.php ([Get your API Key](https://www.killduplicate.com/en/user/api))
UNAUTHORIZED_IP : check IP where script is run from is added to whitelist ([Chech Authorized IPs](https://www.killduplicate.com/en/user/api))
TOO_MANY_REQUESTS : only one request per second is allowed
NO_MORE_CREDITS : you dont' have enough credits to run this scan
EMPTY_TEXT_AND_URL : neither text nor url were provided
INTERNAL_ERROR : internal server error (please contact admin)
UNKNOWN_FORMAT : can only be json|xml
INVALID_CALLBACK_URL : invalid callback URL 

UTF-8 encoding

All texts MUST be encoded in VALID UTF-8. If you load some old Microsoft Words Documents you might have invalid UTF-8 characters like strange quotes. To be sure you have valid UTF-8 encoded texts you can check it :

$validUTF8 = ! (false === mb_detect_encoding($text, 'UTF-8', true));

If your text has invalid UTF-8 characters, you can use some home made functions to convert invalid encoding (problem is that some characters in some encodings can be converted into multiple UTF-8 characters you have to unilateraly decide to which character it will be converted to ... and that's why it's your responsability to make UTF-8 conversion when you use API) : Gist Clean UTF-8, or you can make you own.

HTML entities

Your texts MUST be send WITHOUT HTML entities (You can use PHP function html_entity_decode)

Troubleshouting

Be sure your callback is reachable over the network.

For file permission issues (replace www-data by your webserver username)

chown -R www-data:www-data vendor/impact-seo/killduplicate-api-php/results
chmod -R 775 vendor/impact-seo/killduplicate-api-php/results