Documentation
Build your license flow with confidence
Overview
Architecture, navigation, and docs map.
Quickstart
Run the server, verify health, and generate your first key.
Concepts
Understand slugs, seats, activation flow, and license lifecycle behavior.
Webhook Concepts
Delivery model, idempotency headers, and webhook payload contracts.
Slug Concepts
Slug naming rules, policy fields, and license snapshot behavior at generation time.
Configuration
All environment variables, defaults, and validation behavior.
Stripe Example
Stripe + Vercel webhook example for automatic license generation.
License API
License lifecycle endpoints with request/response examples.
Management API
Management endpoints for slugs, API keys, and webhook configuration.
GET /management/slugs
List slug policy templates.
POST /management/slugs
Create a slug policy template.
GET /management/slugs/{name}
Get a slug policy template by name.
PATCH /management/slugs/{name}
Update a slug policy template.
DELETE /management/slugs/{name}
Delete a slug policy template.
Migration
Upgrade guides across released versions.
0.1.0 -> 0.2.0
Breaking changes and migration checklist for 0.2.0.
POST /generate
Generate a license using a generated server API key.
POST /revoke
Revoke an existing license key.
POST /activate
Activate a license for a fingerprint.
POST /validate
Validate runtime license state.
POST /deactivate
Release a seat by deactivating one fingerprint.
GET /management/api-keys
List generated API keys for provisioning.
POST /management/api-keys
Create a generated server API key.
POST /management/api-keys/{id}/revoke
Revoke a generated API key.
GET /management/webhooks
List configured webhook endpoints.
POST /management/webhooks
Create a webhook endpoint configuration.
PATCH /management/webhooks/{id}
Update webhook endpoint configuration.
DELETE /management/webhooks/{id}
Delete a webhook endpoint.
Try the API now
curl -sS http://localhost:8080/generate \
-H "Authorization: Bearer <generated_server_api_key>" \
-H "Content-Type: application/json" \
-d '{"slug":"default","metadata":{"email":"user@example.com"}}'