SDKs
SDK Overview
Official client libraries for integrating Licentric into your applications.
Built-in conveniences
SDKs handle authentication and error parsing automatically. You focus on licensing logic — the SDK manages the HTTP layer.
Available SDKs
| Language | Package | Requirements |
|---|---|---|
| Python | licentric | Python 3.8+ |
| TypeScript | @licentric/sdk | Node.js 18+ or browser with fetch |
Installation
Install Python SDK
pip install licentricNot yet published
The SDKs are not yet published to PyPI or npm. For now, install from source by cloning the repository and following the instructions in each SDK’s README.
Capabilities
Both SDKs provide the same core capabilities:
- License validation — check if a key is valid, active, and authorized for the current device
- Machine activation — register a device against a license using a hardware fingerprint
- Machine deactivation — release a device slot for floating/transferable licenses
- Heartbeats — periodic check-ins to prove a device is still active
- Offline checkout — download an Ed25519-signed license file for air-gapped environments
Common Integration Pattern
The typical integration follows a three-step pattern: initialize the client, validate the license, and activate the device.
integration.py
from licentric import Licentric
client = Licentric(api_key="lk_live_...")
# 1. Validate the license key
result = client.validate("MYAPP-XXXX-XXXX-XXXX-XXXX", fingerprint="abc123")
# 2. Activate the device (if not already activated)
if result.valid and not result.machine:
machine = client.activate(
key="MYAPP-XXXX-XXXX-XXXX-XXXX",
fingerprint="abc123",
name="Customer Workstation",
)
# 3. Periodically send heartbeats
client.heartbeat(machine_id=machine.id, key="MYAPP-XXXX-XXXX-XXXX-XXXX")Other Languages
Need an SDK in another language? Generate a typed client from our OpenAPI 3.1 spec using tools like openapi-generator, oapi-codegen (Go), or swagger-codegen.
Next Steps
- Python SDK Reference— full method documentation and examples
- TypeScript SDK Reference— full method documentation and examples
- Offline Licensing Guide— air-gapped deployment with Ed25519-signed license files