Noplag’s API (Application Programming Interface) makes it possible to integrate Noplag Plagiarism checker into your Website, Admin or any other Application where you need to check your files or text for similarities. Webmasters and Developers can write scripts on your server that will post request to Noplag and receive results in the form of JSON script. To view Plagiarism Report within your application you can use iFrame. To request access, please contact support or submit Request Access form on this page.
Using the API
To begin using the API, you need to write a script that will send data to the server and receive a response.
To send data to a server you need to write Ajax.
You will need to send the following information:
Parameter | Explanation | Value | Required? |
---|---|---|---|
"api_secret_token" | Your API secret key | secret_npdnwle12qwe12 | Yes |
"sources" | Select one or more sources to check your text. Values separated by a coma. | internet, database, publication, library | Yes |
"data" | Here you should enter your text or upload your files to transfer. | (text/file(s)) | Yes |
Here is an example of the Post Request:
{
'api_secret_token' : 'secret_npdnwle12qwe12',
'sources' : 'internet, database, publication, library',
'data' : (files/texts)
}
You may only send one type of the data: file(s) or text.
URL Search Request
To check for similarities in your file(s) or text via the Noplag API, send an HTTP POST request to this URL:
Example: https://api.noplag.com/v1/text
In order to receive results from the Noplag API, please make sure the following steps are set and ready:
After sending your files, or text, everything will pass in 3 stages:
Monitoring conversion status.
You can get the following conversion statuses:
Status name | Explanation |
---|---|
Queued | Text has been placed in the queue for checking. |
Converting | Your text is converting at the moment. |
Finished | Your text has been successfully converted. |
Failed | Failure to check the text. Please contact support or try again. |
Monitoring checking status.
You can get the following check statuses:
Status name | Explanation |
---|---|
Queued | Text has been placed in the queue for checking. |
Internet | Text has been successfully checked via Web. |
Database | Text has been successfully checked via Database. |
Publication | Text has been successfully checked via Publications. |
Library | Text has been successfully checked via Library. |
Finished | Text has been successfully checked via all chosen sources. |
Failed | Failure to check the text. Please contact support or try again. |
Receiving data from the server
The server response returns JSON script with results of the check.
Conversion
Parameter | Value | Type | Explanation |
---|---|---|---|
"api_secret_token" | secret_abc123def456 | text | Your API secret key |
"stage" | conversion | text | Shows the stage at which is the file on the server. |
"status" | queued/converting/finished/failed | text | Shows the status of the file at this stage. |
"amountPages" | 1 | integer | Shows the number of pages in the document. |
"wordsAmount" | 274 | integer | Shows the number of words in the document. |
"characters" | 1551 | integer | Shows the number of characters in the document. |
"conversionError" | null | null/text | Shows the text of the error conversion. If there is no error, then it will be null. |
"textId" | 11 | integer | The ID of your text. |
"title" | Warcraft | null/text | The title of your document. |
"uploadedBy" | Larry Page | text | It displays the name of the owner of the secret token. |
An example of server response during conversion
{
'secret_token' : "secret_abc123def456",
'amountPages' : 2,
'characters' : 1551,
'conversionError' : null,
'stage' : "conversion",
'status' : "finished",
'textId' : 11,
'title' : "Warcraft",
'uploadedBy' : "Larry Page",
'wordsAmount' : 274
}
Checking
Parameter | Value | Type | Explanation |
---|---|---|---|
"api_secret_token" | secret_abc123def456 | text | Your API secret key |
"stage" | checking | text | Shows the stage at which to be a file on the server. |
"status" | queued/internet/database/publication/library/finished/failed | text | Shows the status of the file at this stage. |
"textId" | 11 | integer | The ID of your text. |
An example of server response during checking
{
'secret_token' : "secret_abc123def456"
'stage' : "checking"
'status' : "internet"
'text_id' : 11
}
When the scan is completed, you will get the following answer:
{
'secret_token' : "secret_abc123def456",
'stage' : "checking",
'status' : "finished",
'language' : "en",
'matches' : 51,
'pagesAmount' : 2,
'report_link' : "http://co.noplag.local/reports/shared?k=eyJpdiI6IkZUaWpFNmV4ZXhvamRoMW9oR0RoVHc9PS
IsInZhbHVlIjoiU2g0TFlNTzI4cFRNam12aG1jN0NHS3lHSzVYWXRyWGdOZ2x5...",
'similarityPercent' : 100,
'text_id' : 11
}
Example that demonstrates how to use the API
Download ExampleImportant! In example, there is the following line of code:
var secret_token = 'secret_abc123def456'; // Insert your secret token here
Handling errors
Checking balance
Parameter | Value | Type | Explanation |
---|---|---|---|
"error" | Ooops! It looks like you ran out of checks! Please check your subscription plan! | text | The error message. The balance in your account is not enough for a successful operation. |
"api_secret_token" | secret_abc123def456 | text | Your API secret key |
"stage" | checking | text | Shows the stage at which to be a file on the server. |
"status" | queued/internet/database/publication/library/finished/failed | text | Shows the status of the file at this stage. |
"textId" | 11 | integer | The ID of your text. |
If your account balance is less than required for successful verification of documents, then you get the following response:
{
'error' : "Ooops! It looks like you ran out of checks! Please check your subscription plan!",
'secret_token' : "secret_abc123def456",
'stage' : "checking_balance",
'status' : "failed",
'textId' : 11
}
Status code | Description |
---|---|
422 | The check failed because of a conversion error. Most likely the input file is corrupt or some parameters are wrong. "Message" contains the error description. |
503 | The conversion failed because there is currently no conversion host available or the conversion host had an internal error. |
How to view the report within your website or admin:
If you want to view the report within your website or admin, you can use iframe and display the report on your site.
Here is an example of how it will look:
Request API Access
Have you ever suffered from the plagiarized content? Enough. Noplag.com offers the Application Programming Interface that detects plagiarism in a matter of seconds due to the best methods and functions available in the modern app market. If you are tired of problems connected with plagiarized texts, Noplag.com API is definitely for you. It may come in handy during app development or be integrated into the third-party system of content management to secure it from non-quality texts – the alternatives are rather different. The only worthy benefit you receive is a comprehensive check of every text for plagiarism with a detailed report that is easy to integrate and use.
Who can benefit from Plagiarism Checker API?
Noplag.com is a trusted leader of plagiarism detecting services that is used by a variety of customers, representatives of different professions and spheres. Nowadays a great number of people has to deal with plagiarism on a daily basis either at work or personally. One of the main spheres that deal with plagiarism incredibly often is education: both teachers and students have to submit all the written papers to similarity checking. Another group of people, who value a high quality of the text, are business representatives including media publishers, lawyers, consulting firms etc. and IT specialists, especially ones hosting websites, SEO agencies, journalists, writers, bloggers etc. Their career greatly depends on the quality of documents and texts they write and receive, so a professional plagiarism detector is a necessity for them.
Reasons to choose Noplag.com API
People, who at least once have used plagiarism checkers, know that the procedure takes some time, which is usually incredibly valuable. With the appearance of plagiarism checking API users can spend much less time for this purpose as well as appreciate a number of other advantages offered by Noplag API:
How to order and use Noplag.com API
There is nothing extraordinary in executing plagiarism checks using our API. It is enough to register on our website and request for an API access. If there are any difficulties or questions, our support team is always ready to address any of your concerns or issues.