Lukittu

Heartbeat

POSThttps://lukittu.com/api/v1/license/{teamId}/heartbeat

The heartbeat endpoint can be called at intervals of 5 to 30 minutes, depending on the level of control you want. The heartbeat is used to track the number of active users for a license at any given time. Based on these heartbeats, you can limit the number of concurrent users per license.

Request

Path Params

teamId

string

required

Your team's UUID. You can get this from your team's settings.

Example:

licenseKey

string

required

customerId

string

optional

Required if 'strict customers' is enabled in the team's settings and at least one customer is assigned to the license.

productId

string

optional

Required if 'strict products' is enabled in the team's settings and at least one product is assigned to the license.

deviceIdentifier

string

optional

Any identifier that uniquely identifies the current device. This could be generated from the hardware (HWID) or as a random identifier when the software first starts on the client's machine.

>= 10 characters<= 10000 characters

challenge

string

optional

The challenge can be any string. It will be signed on the backend using a private key and returned to the client. On the client side, you should validate the challenge using the corresponding public key.

<= 1000 characters

{
  "licenseKey": "string",
  "customerId": "string",
  "productId": "string",
  "deviceIdentifier": "stringstri",
  "challenge": "string"
}

Request samples

Responses

OK(200)

Bad Request(400)

HTTP Code: 200

Content Type : JSONapplication/json

result

object

required

timestamp

string

required

valid

boolean

required

details

string

required

code

enum<string>

required

Allowed values:

INTERNAL_SERVER_ERRORBAD_REQUESTLICENSE_NOT_FOUNDVALIDIP_LIMIT_REACHEDPRODUCT_NOT_FOUNDCUSTOMER_NOT_FOUNDLICENSE_EXPIREDLICENSE_SUSPENDEDMAXIMUM_CONCURRENT_SEATSTEAM_NOT_FOUNDRATE_LIMITDEVICE_IDENTIFIER_BLACKLISTEDCOUNTRY_BLACKLISTEDIP_BLACKLISTED

challengeResponse

string

optional

Present if challenge was given

{
  "result": {
    "timestamp": "string",
    "valid": true,
    "details": "string",
    "code": "INTERNAL_SERVER_ERROR",
    "challengeResponse": "string"
  }
}

Last modified: 17 days ago