Noplag API Access

Noplag’s API (Application Programming Interface) makes it possible to integrate Noplag Plagiarism checker in to 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:

  1. Your Current Balance - Before sending the API data, make sure that your account balance is sufficient for the operation. Otherwise, you will get the following error "Your balance is too low to check the file(s)".
  2. API Secret Token - This unique key will allow you to use the Noplag API. In order to receive the secret token, please sign with Noplag and fill out this form to request for the API. (Noplag account email address, Company, Website or Institution Name Please explain your needs for API? )

After sending your files, or text, all will pass in 3 stages:

  1. First, you will get the status of conversion of your files/text;
  2. Second, the system will check your balance. If it is less necessary for the successful execution of testing, then you get an error.
  3. Finally, you will get the check status of your material at the specified resources.

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 is 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.
  • For the most comfortable and quick check on the status of the text by the user server using sockets.
  • In the code example above, has written a small script to get the information from the socket server.
  • By default given the following options on client side:
  • 'maxRetries': 10 // The number of attempts to connect to the server socket.
  • 'retryDelay': 10000 // The time interval between attempts to connect.

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 to be a 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 complete, 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 which demonstrate how to use the API

Download Example

Important! In example, there is the following line of code:

                        
                            var secret_token = 'secret_abc123def456';   // Insert your secret token here
                        
                    
Be sure to enter your secret token here. Thanks to him, you will be able to connect by the socket and receive data in your browser.

Handling errors

Checking balance

Parameter Value Type Explanation
"error" Darn! Your balance is too low to check the file(s) 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' : "Darn! Your balance is too low to check the file(s)",
                                '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 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:

  1. Speed and 100% accuracy of performance. Noplag.com works incredibly fast and the quality of checking never suffers because of that – only premium accuracy for each analyzed paper.
  2. Provision of the resource websites. If Noplag detects any hints of plagiarism or even copy-pasted pieces, it automatically shows the address of the resource it was taken from.
  3. Safety and security. Being a trusted service we value each our client and guarantee the confidentiality of every checked content. It is our priority to secure users from any information leaks and never to share any personal data or content.
  4. Simple installation and configuration procedure. There is no need to have some specific knowledge and skills to be able to use Noplag API – our staff will provide you with any necessary information if there are any questions or difficulties.
  5. Support of different types of files and languages. Noplag works with numerous file formats as well as a variety of languages.
  6. A possibility to choose. We never stick to a single plan working with our clients. Each person is treated individually that is why we offer a list of plans to meet exactly your requirements and preferences.

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.

Wait a moment...