KeyforgeDocs

Quickstart

You can set up Keyforge in your project within minutes. This guide will walk you through the steps to get started.

Choose whether to integrate Keyforge directly in your client or server.

Client-side

Integrate Keyforge into a desktop app, browser extension, and more.

Server-side

Set up Keyforge in your backend server, API, and more.

Licensing your client application

To validate and activate licenses in the client side, you can use the Public REST API directly in your app. You can use this API anywhere, including desktop apps and browser extensions, with any programming language.

Prerequisites

Before you begin, make sure you have completed the following steps:

  • Create a product here.
  • Create a license here.

Validate a license

Whenever your app starts, you can validate the license to check if it's valid. Here is how to make the HTTP request to validate a license.

You can validate a license whenever you like, for example, every hour, to ensure that the license is still valid.

const res = await fetch(
  'https://keyforge.dev/api/v1/public/licenses/validate',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      licenseKey: 'ABCDE-ABCDE-ABCDE-ABCDE-ABCDE',
      productId: 'p_123456',
      deviceIdentifier: 'some_device_id',
    }),
  }
);
 
const data = await res.json();
 
console.log(data.isValid);

Activate a license

The first time a user opens your app, they should be prompted to activate their license. Here is how to make the HTTP request to activate a license.

The device identifier needs to be unique inside the license scope. You can use a MAC address, HWID, or any other type of identifier that is unique to a device.

await fetch('https://keyforge.dev/api/v1/public/licenses/activate', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    licenseKey: 'ABCDE-ABCDE-ABCDE-ABCDE-ABCDE',
    productId: 'p_123456',
    deviceIdentifier: 'some_device_id',
    deviceName: 'My device',
  }),
});
 
console.log('License activated');

Congratulations! 🎉

You have successfully validated and activated your first license inside your app. You can manage all your licenses in the dashboard.

Learn more

Public API

Learn more about the public REST API. An API key is not needed to use the public API.

Validate license

Validate a license.

Activate license

Activate a license.

Next

Introduction

Next

Examples

On this page