Manage your credits
Copyleaks is a paid service that allows you to integrate your solution with a plagiarism detection framework. It's important to integrate with Copyleaks API in a smart way that will help prevent the misuse of your page's resources (credits).
Copyleaks provides their customers with multiple ways to prevent excess use of their services. In this article we will explain the options you have.
Price check before scan
Some of our customers' applications are not aware of their document sizes due to end-users submitting files themselves. Due to scanning large documents unnecessarily, this can result in excessive credit use that is not warranted by the platform.
In order to prevent this scenario, Copyleaks recommends you check the number of credits each document contains and then decide if you want to continue the scan or not. If you decide to stop the scan process, you will not pay the expected credits for the scan.
In order to activate the "Check-Credits" flow, you have to specify the parameter properties.action to 1 (Check-Credits) while submitting the document.
Learn more about this flow here .
Confirm the price after scan completed
As part of the scanning flow, after each scan becomes completed, we will notify your application of a Completed Webhook . This webhook also contains information about the cost of the scan. You can track this information on your end and build your understanding about the expected services costs.
Note: You will pay only for successfully completed scans. Scan that ends with any kind of errors will be automatically refunded.
Ensure your remaining credits programmatically
Copyleaks API was built to provide developers around the world the flexibility to use the service without the need of managing the integration with "human hands" during the process. Because of that, we provided you accessibility for the number of credits you currently have on Copyleaks.
You will need this information, in order to:
- Enforce spending limits on your end. You can define that until the middle of the month you expect to spend no more than 50% of your monthly budget. Then, your application will react according to your current budget.
- Define alerts on your end to monitor the number of remaining credits. For example, send alerts when you have less than 10% of your credits. If the value goes below some threshold value, you will create an alert that notifies the right person about the event. This job can be done as a cron-job and you can monitor this value as frequently as needed (according to rate limits policy).
Learn more about accessing your current credits balance:
Put a spend limit on automatic refills
In order to prevent a situation where you will run out of credits in the middle of the billing period, we strongly advise activating the automatic refills option.
The automatic refill option will purchase the plan exactly when you run out of credits to complete your on-going scans. All of this, without human intervention.
Copyleaks advises you to limit your automatic refills option for your maximum budget. Without limiting this option, you will be exposed to unexpected costs caused by exceeded use. Those costs can also happen because of a "bug" on your code. In order to be on the safe side, define your maximum budget.
In order to use this feature, enter your billing page to manage it.
Predict your usages
In order for you to define a usage budget, Copyleaks API provides you information about your historical usages.
By accessing the usages history, you will get a report about your usages between two dates. The report is a CSV file that allows you to track your historical usages and predict your further usage.
Learn more about usages history:
As you can see, Copyleaks API gives you wide flexibility in order to develop a successful integration. Use this flexibility smartly, to prevent unwanted excess use.
Do you have a technical question?
Use stackoverflow.com to get help from our development team and other Copyleaks users.