Documentation
Documentation
Welcome to the complete documentation for the License Management Platform.
Overview
This documentation covers all aspects of the platform, from API integration to portal usage.
Documentation Sections
API Documentation
Complete API reference generated directly from the Postman collection.
- 39 Endpoints documented with request/response examples
- Authentication and authorization
- Error handling
- Rate limiting
- Environment isolation
Categories:
- Core Endpoints - License management, products, contracts, telemetry
- Error Responses - API key errors, access restrictions
- Public Endpoints - Changelog and public resources
Admin Portal
Comprehensive guide for administrators managing the platform.
Covers:
- Product and license management
- Generator configuration
- Contract management
- Customer management
- API key management
- Webhooks and integrations
- Telemetry and analytics
- System settings and configuration
- Security and access control
Customer Self-Service Portal
Guide for end customers managing their licenses.
Covers:
- License viewing and management
- Activation management
- Download access
- Profile and settings
- Security features
- Data isolation guarantees
License Lifecycle
Detailed documentation of license states, transitions, and validation rules.
USB Offline Licensing
Documentation for offline license validation and USB-based licensing.
Webhook Integration
Guide for integrating with the webhook system.
Source of Truth
This documentation follows strict source-of-truth rules:
- API Documentation - Generated from Postman collection ONLY
- Portal Documentation - Derived from actual code + existing documentation
- No mixing of sources - Each section has a single, authoritative source
Getting Started
- Developers - Start with API Documentation
- Administrators - Start with Admin Portal
- End Users - Start with Customer Portal
Additional Resources
- License Lifecycle - Understanding license states
- USB Offline Licensing - Offline validation
- Webhook Integration - Event-driven integration
Last updated on