Register a production domain for Nutrient Web SDK
Nutrient Web SDK checks the hostname of the browser tab’s origin against the domain registered on your license. Register your application’s exact production domain to use your license key without trial watermarks.
Determine your exact production domain
Register the exact domain in the browser’s address bar, including any subdomain. On the page that loads Nutrient Web SDK, run this command in the JavaScript console:
console.log(location.hostname);Register the returned value. It doesn’t include the protocol, port, or path. For example, for https://www.example.com:8443/app, it returns www.example.com.
For applications that use multiple domains simultaneously, including multiple subdomains of the same domain, contact the Support team(opens in a new tab) to discuss a custom solution. Examples include sales.internal.example.com and board.internal.example.com.
Register the domain in the Nutrient Portal
Register your production domain through your Web SDK license:
- Log in to the Nutrient Portal(opens in a new tab).
- Open Manage Licenses.
- Locate your Web SDK license.
- Enter the domain that
location.hostnamereturned. - Save your changes.
- Copy the resulting license key.
Add the license key to your application
Pass the license key when loading the SDK:
NutrientViewer.load({ ... licenseKey: "your key goes here", ...});For setup instructions, refer to the adding the license key guide.
Domains ending in .local serve development or intranet environments. Don’t register them as production domains. To use a .local domain in production, contact the Sales team. If you registered one by mistake, contact the Support team(opens in a new tab). Provide the replacement domain.
Change or remove a registered domain
The Nutrient Portal doesn’t support changing or removing registered domains. To request a change, contact the Support team(opens in a new tab). Provide the domain to remove and, for replacements, the new domain.
If your application passes a licenseKey, update the key after support registers the replacement domain:
- Copy the new domain’s license key from the Nutrient Portal(opens in a new tab).
- Replace the
licenseKeyvalue in your application.
If your application uses Document Engine, apply the change there too. Refer to the domain and subdomain access guide.
Request a beta domain or an Electron app name
Development, testing, staging, and quality assurance (QA) environments use beta domains instead of production domains. Electron applications use an app name.
Beta domain usage
Request a beta domain for development, testing, staging, or QA environments. Include a recognizable non-production indicator in the domain name to qualify for the shorter approval process. Examples include staging.example.com and app.example.dev.
For naming rules and request steps, refer to the requesting a beta usage domain guide.
App name for Electron
Electron applications don’t run in browser tabs, so Web SDK doesn’t validate them against a registered domain. Identify your Electron application with an appName value in your configuration:
const configuration = { document, container: "#root", appName: "your-electron-app-name", licenseKey: "your key goes here",};
instance = await NutrientViewer.load(configuration);Request the matching app name through the beta/development license request in the Nutrient Portal(opens in a new tab). Enter your app name instead of a domain.
For integration instructions, refer to the Electron getting started guide.
Related guides
Refer to these guides for related licensing tasks:
- License troubleshooting covers common license errors, including domain mismatches.
- Requesting a beta usage domain covers naming rules and requests for non-production environments.
- Nutrient Web SDK licensing covers the subscription model and domain deployment.