Using IronOCR License Keys
How to Get a License Key
Adding an IronOCR license key allows you to deploy your project live without restrictions or watermarks.
You can buy a license key or sign up for a free 30 day trial key here.
Step 1: Download the Latest Version of IronOCR
Start using IronOCR in your project today with a free trial.
Install via DLL
Download the IronOCR DLL directly to your machine.
Install via NuGet
Alternatively, you can install through NuGet.
Step 2: Apply Your License Key
Set your IronOCR license key using code
Add this code to the startup of your application, before IronOCR is used.
// Set your IronOCR license key at the beginning of your application
IronOcr.License.LicenseKey = "IRONOCR-MYLICENSE-KEY-1EF01";' Set your IronOCR license key at the beginning of your application
IronOcr.License.LicenseKey = "IRONOCR-MYLICENSE-KEY-1EF01"You can validate that your software is licensed using either IronOcr.License.IsValidLicense(string LicenseKey) or the IronOcr.License.IsLicensed property.
Set your license key using Web.Config or App.Config
To apply a key globally to your application using Web.Config or App.Config, add the following key to your config file in appSettings.
<configuration>
...
<appSettings>
<!-- Set your IronOCR license key here -->
<add key="IronOcr.LicenseKey" value="IRONOCR-MYLICENSE-KEY-1EF01"/>
</appSettings>
...
</configuration>There is a known licensing issue between IronOCR version 2023.4.13 - 2024.3.4 on projects:
- ASP.NET projects
- .NET Framework version >= 4.6.2
The key stored in a Web.config file is NOT being picked up and used by the product. Visit the 'Setting License Key in Web.config' troubleshooting article to learn more.
Set your key using a .NET Core appsettings.json file
To apply a key globally to your application with .NET Core:
- Add a JSON file to your project called
appsettings.jsonin the root directory of your project. - Add a 'IronOcr.LicenseKey' key to your JSON config file. The value should be your license key.
- Ensure that the file properties include Copy to Output Directory: Copy always.
- Ensure that
IronOcr.License.IsLicensedreturnstrueto verify.
File: appsettings.json
{
"IronOcr.LicenseKey": "IRONOCR-MYLICENSE-KEY-1EF01"
}Step 3: Test your key
Test if your key has been installed correctly.
// Validate the license key
bool result = IronOcr.License.IsValidLicense("IRONOCR-MYLICENSE-KEY-1EF01");' Validate the license key
Dim result As Boolean = IronOcr.License.IsValidLicense("IRONOCR-MYLICENSE-KEY-1EF01")Step 4: Get started with your project
Follow our tutorial on how to Get Started with IronOCR.
Questions?
If you have any questions, reach out to support@ironsoftware.com
Frequently Asked Questions
What is the importance of adding a license key to IronOCR?
Adding a license key to IronOCR allows you to deploy your project live without any restrictions or watermarks, ensuring proper functionality and compliance.
How can I obtain a license key for IronOCR?
You can purchase a license key directly from the Iron Software website or sign up for a free 30-day trial key.
What is the process for installing IronOCR via DLL?
You can download the IronOCR DLL directly to your machine for installation, enabling offline use and easier control over updates.
Can I install IronOCR through a package manager?
Yes, you can install IronOCR using NuGet, which allows for easy integration and management within your C# projects.
How do I apply my IronOCR license key in a C# application?
You should set your IronOCR license key at the beginning of your application using the code: `IronOcr.License.LicenseKey = "YOUR-LICENSE-KEY-HERE";`.
Is there a known issue with IronOCR license keys for specific .NET projects?
Yes, there is a known licensing issue for ASP.NET projects and .NET Framework version >= 4.6.2 where the key stored in a `Web.config` file is not used correctly.
How can I apply the IronOCR license key globally in a .NET Core project?
In a .NET Core project, you should include your license key in an 'appsettings.json' file and ensure it is set to copy to the output directory.
How do I test if my IronOCR license key is installed correctly?
You can test your key by using the method `IronOcr.License.IsValidLicense("YOUR-LICENSE-KEY-HERE")` to verify if the license is valid.
What should I do if I encounter issues setting my license key in Web.config?
Refer to the '[Setting License Key in Web.config](/csharp/ocr/troubleshooting/license-key-web.config/)' troubleshooting article for detailed guidance.
Who can I contact for further assistance with IronOCR licensing?
If you have any further questions, you can reach out to the Iron Software support team at support@ironsoftware.com.
Curtis Chau holds a Bachelor’s degree in Computer Science (Carleton University) and specializes in front-end development with expertise in Node.js, TypeScript, JavaScript, and React. Passionate about crafting intuitive and aesthetically pleasing user interfaces, Curtis enjoys working with modern frameworks and creating well-structured, visually appealing manuals.
