Documentation

Get started in 5 minutes

Issue your first license, validate it from your app, and ship.

1 Create a product

Sign in to the dashboard, create a product, and copy the public/secret key pair. The secret is shown only once.

2 Install the SDK 

pnpm add @paperkeyhq/sdk

3 Validate a license 

import { createClient, getFingerprint } from '@paperkeyhq/sdk';

const paperkey = createClient({ apiKey: process.env.PAPERKEY_PK! });
const { fingerprint } = await getFingerprint();

const result = await paperkey.validate(licenseKey, fingerprint);
if (!result.valid) {
  console.error('License is invalid:', result.error);
  process.exit(1);
}

4 Activate on first run 

const result = await paperkey.activate(licenseKey, fingerprint, 'My MacBook');
if (!result.success) throw new Error(result.error);
console.log('Activations remaining:', result.activationsRemaining);

Next