# Lukittu Documentation

## Docs

- [Introduction](https://docs.lukittu.com/introduction.md): Lukittu is a modern software licensing service that provides robust APIs to add an additional licensing layer to your software, enhancing security and trackability. This documentation contains all the information you need to get started.
- [Products](https://docs.lukittu.com/platform/products.md): A product in Lukittu represents a software application that you want to manage access to. Through Lukittu's flexible access control system, each license key can grant access to one or multiple products.
- [Licenses](https://docs.lukittu.com/platform/licenses.md): Licenses are the cornerstone of the Lukittu system, providing access control to your software. Without a valid license, users cannot access your software. License keys enable you to track software usage and prevent unauthorized access.
- [Webhooks](https://docs.lukittu.com/platform/webhooks.md): Use webhooks to receive real-time notifications about events in your Lukittu account.
- [Settings](https://docs.lukittu.com/platform/settings.md): Configuration settings for your Lukittu team.
- [Stripe Integration](https://docs.lukittu.com/integrations/stripe.md): Lukittu supports Stripe by automatically delivering licenses to customers via email upon purchase.
- [BuiltByBit Integration](https://docs.lukittu.com/integrations/built-by-bit.md): Lukittu supports BuiltByBit by providing a fully automatic licensing experience for your resources.
- [Polymart Integration](https://docs.lukittu.com/integrations/polymart.md): Lukittu supports Polymart by providing a fully automatic licensing experience for your resources.
- [Discord Integration](https://docs.lukittu.com/integrations/discord.md): Connect Lukittu to Discord for seamless license management through bot commands.
- [Self-hosting](https://docs.lukittu.com/hosting/self-hosting.md): Information about self-hosting options and considerations for the Lukittu platform
- [Managed Hosting](https://docs.lukittu.com/hosting/managed-hosting.md): Official managed hosting options for Lukittu, including free and Pro plans
- [General overview](https://docs.lukittu.com/security/general.md): Lukittu client-server communication employs a sophisticated hybrid cryptographic system that combines both asymmetric (RSA 2048) and symmetric encryption to ensure maximum security and integrity. This documentation provides a detailed overview of the communication processe
- [Introduction](https://docs.lukittu.com/api-reference/introduction.md): Overview of the Lukittu API documentation, including endpoints, request and response formats, parameters, and examples.
- [Verify License](https://docs.lukittu.com/api-reference/client--verify/verify-license.md): This endpoint is used to validate a license key with the Lukittu backend.  Typically, you should call this endpoint when your software starts and act based on the response provided.
- [License Heartbeat](https://docs.lukittu.com/api-reference/client--verify/license-heartbeat.md): The Heartbeat endpoint is used to determine whether a specific device is still active.  You should call this endpoint at regular intervals (e.g., once every 30 minutes).  This process also validates the license key in a similar way to the Verify License endpoint.
- [Download Release](https://docs.lukittu.com/api-reference/client--verify/download-release.md): The Classloader endpoint is used to download a release file. It is primarily intended for programming languages  that support loading business logic code directly from a remote server into memory. For example, this is commonly used with Java classloaders.
- [List Licenses](https://docs.lukittu.com/api-reference/dev--licenses/list-licenses.md): Retrieve a paginated list of licenses for the specified team. Results can be filtered by product and customer associations.
- [Create License](https://docs.lukittu.com/api-reference/dev--licenses/create-license.md): Create a new license with the specified configuration. The license will be automatically generated with a unique key.
- [Get License by ID](https://docs.lukittu.com/api-reference/dev--licenses/get-license-by-id.md): Retrieve a specific license by its unique identifier.
- [Update License](https://docs.lukittu.com/api-reference/dev--licenses/update-license.md): Update an existing license's properties including expiration, limits, metadata,  associated products, and customers. Can also update the license key itself.
- [Delete License by ID](https://docs.lukittu.com/api-reference/dev--licenses/delete-license-by-id.md): Delete a license by its unique identifier.  **This operation is permanent and cannot be undone.**
- [Get License by Key](https://docs.lukittu.com/api-reference/dev--licenses/get-license-by-key.md): Retrieve a specific license by its license key.
- [Delete License by Key](https://docs.lukittu.com/api-reference/dev--licenses/delete-license-by-key.md): Delete a license by its license key.  **This operation is permanent and cannot be undone.**
- [List License Hardware Identifiers](https://docs.lukittu.com/api-reference/dev--licenses/list-license-hardware-identifiers.md): Retrieve a paginated list of hardware identifiers (HWIDs) associated with a specific license. Includes status calculation based on team timeout settings and filtering options.
- [Update Hardware Identifier Status](https://docs.lukittu.com/api-reference/dev--licenses/update-hardware-identifier-status.md): Update the forgotten status of a hardware identifier. This allows you to  "forget" (soft delete) or "remember" (restore) hardware identifiers.
- [List License IP Addresses](https://docs.lukittu.com/api-reference/dev--licenses/list-license-ip-addresses.md): Retrieve a paginated list of IP addresses associated with a specific license. Includes status calculation based on team timeout settings, country information, and filtering options.
- [Update IP Address Status](https://docs.lukittu.com/api-reference/dev--licenses/update-ip-address-status.md): Update the forgotten status of an IP address. This allows you to  "forget" (soft delete) or "remember" (restore) IP addresses.
- [List Releases](https://docs.lukittu.com/api-reference/dev--releases/list-releases.md): Retrieve a paginated list of releases for a specific product within the team. Results can be filtered by version search and release status.
- [Create Release](https://docs.lukittu.com/api-reference/dev--releases/create-release.md): Create a new release for a product. Supports optional file upload via multipart/form-data.
- [Update Release](https://docs.lukittu.com/api-reference/dev--releases/update-release.md): Update an existing release. Supports optional file upload/replacement via multipart/form-data.
- [List Customers](https://docs.lukittu.com/api-reference/dev--customers/list-customers.md): Retrieve a paginated list of customers for the specified team. Supports search, pagination, and sorting capabilities.
- [Create Customer](https://docs.lukittu.com/api-reference/dev--customers/create-customer.md): Create a new customer record for the specified team. Customers can be associated with licenses for tracking and management.
- [Get Customer by ID](https://docs.lukittu.com/api-reference/dev--customers/get-customer-by-id.md): Retrieve detailed information about a specific customer by their unique identifier.
- [Update Customer](https://docs.lukittu.com/api-reference/dev--customers/update-customer.md): Update an existing customer's information including email, name, metadata, and address.
- [Delete Customer by ID](https://docs.lukittu.com/api-reference/dev--customers/delete-customer-by-id.md): Permanently delete a customer and all associated data including metadata and address information. **Warning**: This action cannot be undone.
- [Get Team Statistics](https://docs.lukittu.com/api-reference/dev--statistics/get-team-statistics.md): Returns combined usage statistics for a team, including license counts, request metrics, top countries, top products, and recent activity.
- [Introduction](https://docs.lukittu.com/examples/introduction.md)
- [Simple](https://docs.lukittu.com/examples/java/simple.md)
- [Advanced](https://docs.lukittu.com/examples/java/advanced.md)

## OpenAPI Specs

- [openapi](https://docs.lukittu.com/api-reference/openapi.json)

## Optional

- [Documentation](https://docs.lukittu.com)
- [Discord-server](https://discord.lukittu.com)
- [Blog](https://www.lukittu.com/blog)