A minimal template for a hardware based licensing and authentication system, written in TypeScript using Express & MongoDB (Mongoose).

1. Git clone https://github.com/arevi/express-mongo-license-api-template.git

2. npm install

3. Rename the "database.sample.ts" file to "database.ts"

4. Provide your MongoURI within this file.

The following below is a minimal API specification to provide a quick overview of the template functionality.

The verify route provides an API route for sending a license key and machineId. This route will check if the key is currently bound to a machine. If it is bound to a machine it will verify it is the current machine being requested. If the key is not bound, it will then be bound the requesting machine.

Example Payload

POST

{
    "key":"123456",
    "machineId":"000000"
}

The request route provides a convenient API route for removing the association of a machineId to a license key.

Example Payload

POST

{
    "key":"123456"
}

The heartbeat route provides a simple api route for verifying a machineId is still registered to a key within this database. This helps prevent key abuse by authenticating, then resetting and allowing someone else to reuse a key.

The machineID is passed as a URL parameter.

Example Request

GET /auth/heartbeat/000000

To keep the project minimal and simplified the API provides a preset number of responses corresponding to the result of the data result.

{
    "message": "Success"
}

{
    "message":"Key reset"
}

{
    "message": "Invalid key"
}

{
    "message":"Bad request"
}

{
    "message":"The key is already bound."
}