Activate license

You can activate a license using the SDK. Here is an example of how to activate a license:

import { Keyforge } from 'keyforge-js';
 
const keyforge = new Keyforge('sk_1234');
 
const license = await keyforge.licenses.activate(
  'ABCDE-ABCDE-ABCDE-ABCDE-ABCDE',
  {
    productId: 'p_123456',
    device: {
      identifier: 'some_device_id',
      name: 'My computer name',
    },
  }
);

Parameters

Prop	Type	Default
`key`	`string`	-
`params`	`ActivateLicenseParams`	-

ActivateLicenseParams type

Prop	Type	Default
`productId`	`string`	-
`device`	`object`	-

Activate device object type

Prop	Type	Default
`identifier`	`string`	-
`name`	`string`	-

Device identifier

There are various ways to get a unique identifier of a device. For example, you can use the MAC address, HWID, serial number, or a randomly generated UUID stored in the device.

Returns

Here is an example of the activated license object:

{
  "key": "ABCDE-ABCDE-ABCDE-ABCDE-ABCDE",
  "userId": "05d27bfb-61c7-45f7-9d07-09a41defc88a",
  "productId": "p_123456",
  "type": "perpetual",
  "expiresAt": null,
  "revoked": false,
  "email": "[email protected]",
  "maxDevices": 2,
  "activeDevices": [
    {
      "identifier": "some_device_id",
      "name": "My computer name",
      "activationDate": "2024-05-19T18:39:33.000Z"
    }
  ],
  "createdAt": "2024-05-19T18:39:33.000Z"
}

Activate license

Parameters

ActivateLicenseParams type

Activate device object type

Returns

On this page