Software Licensing integration guide
Software Licensing connects supported other product modules workflows to LucidCP. Use this checklist to configure, link and validate the module before production traffic.
Procedure
Step-by-step
-
01
Plan the licence policy
Choose the licence-key prefix, activation limit and binding policy (domain, IP, both or none). The Software Licence module runs inside LucidCP and does not require a third-party provider account.
Step 1 of 16 · Define the key format, activation limit and binding policy before creating the product.Select the preview to inspect the full-resolution interface. -
02
Confirm the module is available
Open Developer → Modules & Gateways and verify that the Software Licensing module is installed and available before creating a connection or product.
Step 2 of 16 · Confirm that Software Licensing is available in Developer → Modules & Gateways.Select the preview to inspect the full-resolution interface. -
03
Add the local Software Licence connection
Open Infrastructure → Servers, add the Software Licence module and enter a descriptive label such as the licence service hostname. No remote endpoint or API secret is required.
Step 3 of 16 · Create the local Software Licence entry used by licence products.Select the preview to inspect the full-resolution interface. -
04
Confirm the local licence module
Save the connection and run its built-in check. LucidCP should report that the module works locally and requires no remote connection.
Step 4 of 16 · Confirm that the local licence module is ready without external credentials.Select the preview to inspect the full-resolution interface. -
05
Choose a licence routing group if needed
A server group is optional for the local licence module. Use one only when it helps organise multiple licence brands or operational environments.
Step 5 of 16 · Optionally group local licence entries when separate brands or environments need routing.Select the preview to inspect the full-resolution interface. -
06
Create the LucidCP product package
Open Products / Services → All Products, create a product category if needed, then select New Product. Use one LucidCP product for each package customers should be able to order.
Step 6 of 16 · Create the sellable LucidCP product package from Products / Services.Select the preview to inspect the full-resolution interface. -
07
Complete package details
On the Detail tab, set the package name, category, descriptions, visibility, stock and order limits. Keep the product hidden while the automation is being tested.
Step 7 of 16 · Complete the package identity, catalogue placement, visibility and ordering rules on the Detail tab.Select the preview to inspect the full-resolution interface. -
08
Describe the server features
On Server Features, add the customer-facing feature list and structured CPU, RAM, disk and traffic values used by storefront comparison tables.
Step 8 of 16 · Add package features and structured specifications exactly as customers should see them.Select the preview to inspect the full-resolution interface. -
09
Map the Software Licence module
On Automation Settings, select the Software Licence entry or group. No provider-side package ID is required because LucidCP generates the key locally.
Step 9 of 16 · Map the product to the local Software Licence module.Select the preview to inspect the full-resolution interface. -
10
Configure licence generation
Set the key prefix, maximum activations and binding mode in the module-specific fields, then enable Automatic Provisioning so a paid order generates its key.
Step 10 of 16 · Set key prefix, activation limit, binding mode and automatic provisioning.Select the preview to inspect the full-resolution interface. -
11
Configure pricing and billing cycles
On Pricing, enter only the cycles you sell, choose the default cycle and set any one-time setup fee. Confirm currency and tax treatment before publishing the package.
Step 11 of 16 · Set recurring prices, the default billing cycle, setup fee and tax behaviour.Select the preview to inspect the full-resolution interface. -
12
Add options, requirements and upgrades
Attach optional add-ons, required customer inputs and valid upgrade targets where the package needs them. Do not duplicate values that the Software Licensing module already controls automatically.
Step 12 of 16 · Attach only the optional add-ons, order requirements and upgrade paths required by this package.Select the preview to inspect the full-resolution interface. -
13
Save and verify the storefront package
Save the product, re-open each tab to confirm the values persisted, then inspect the customer store preview for the name, features, available cycles and order requirements.
Step 13 of 16 · Verify the completed package in the customer store before accepting a live order.Select the preview to inspect the full-resolution interface. -
14
Generate and verify a test licence
Place a non-production order, complete its invoice and confirm that LucidCP generates a unique key. Call the licence verification endpoint from the test application and validate the Ed25519-signed response.
Step 14 of 16 · Confirm key generation, activation limits and signed API verification with a controlled order.Select the preview to inspect the full-resolution interface. -
15
Verify customer delivery
Open My Services in the customer workspace and confirm that the delivered Software Licensing service, credentials, status, usage information and supported actions are shown correctly.
Step 15 of 16 · Check the delivered Software Licensing service and its available customer controls.Select the preview to inspect the full-resolution interface. -
16
Monitor provisioning after launch
Review the module queue, failed jobs, activity log and provider log during the first production orders. Correct the underlying mapping or provider error before retrying a failed action.
Step 16 of 16 · Follow provisioning jobs and investigate any failed module action before retrying it.Select the preview to inspect the full-resolution interface.
Checklist
Best practices
- Start with the smallest API permission set and expand only when a documented action requires it.
- Rotate provider credentials regularly and immediately after a suspected leak.
Reference
Module details
- Integration
- Software Licensing
- Category
- Other Product Modules
- Availability
- Included with licence
- Directory page
- View integration profile
