Generating Keys¶
Accessing the server¶
Open the License Key Server in a browser. You will be prompted for HTTP basic auth credentials. Enter the AUTH_USER and AUTH_PASS set during deployment.
License Key Server — main page
Key types¶
Date-range key¶
A date-range key authorizes calibration changes between two specific dates. This is the standard key type for on-site calibration visits.
Fields:
| Field | Format | Description |
|---|---|---|
| Valid From | YYYYMMDD |
First day the key is valid |
| Valid To | YYYYMMDD |
Last day the key is valid (inclusive) |
Example: A technician visiting the customer site on March 15–17 should receive a key valid from 20260315 to 20260318 (one day of buffer is recommended).
Steps:
1. Select Date-Range Key.
2. Enter the start date in Valid From.
3. Enter the end date in Valid To.
4. Click Generate Key.
5. Copy the key from the output box.
Date-range key output
Permanent key¶
A permanent key has no expiration. The guard treats it as always valid regardless of today's date.
Use permanent keys for: - Internal ViciVision engineering machines - Long-term service contracts where re-keying is impractical - Development and testing environments
Steps: 1. Select Permanent Key. 2. The Date Issued field defaults to today (auto-filled). You can change it. 3. Click Generate Key. 4. Copy the key.
Permanent keys cannot be revoked remotely
Once a permanent key is installed in the Registry on a customer machine, it remains valid until the key is removed from the Registry or the secret is rotated. Issue permanent keys only when necessary.
Sending the key to the customer¶
Copy the generated key string and send it to the customer or technician via a secure channel (email, encrypted message, etc.). Include:
- The key string
- Instructions to install it via VIA Onboard → Settings → Service → License Key
- The validity dates (for date-range keys), so the customer knows when to expect it to expire
Installing the key¶
The customer installs the key on their machine using VIA Onboard. See Calibration Guard — License Keys for full installation instructions.
API reference¶
The server exposes a single endpoint for programmatic key generation:
POST /api/generate-key
Content-Type: application/json
Authorization: Basic <base64(user:pass)>
Date-range key:
{
"type": "daterange",
"validFrom": "20260301",
"validTo": "20260401"
}
Permanent key:
{
"type": "permanent",
"dateIssued": "20260304"
}
Response (success):
{ "key": "Q2FsaWJHdWFyZDIwMjQ..." }
Response (error):
{ "error": "\"Valid From\" must be before \"Valid To\"." }
Date validation rules:
- All dates must be valid calendar dates in YYYYMMDD format.
- For date-range keys, validFrom must be strictly before validTo.
- For permanent keys, dateIssued defaults to today if omitted.