Documentation

Documentation

This section is the home for developer documentation covering the LICOFY platform. Whether you are building with the licencing API, integrating a product into the marketplace, building a hosted product, or looking for the format and conventions that every product listing follows, the material here will get you started quickly and help you avoid common integration mistakes.

Licencing API Overview

The licencing API is the mechanism a product uses to verify that a deployed licence is valid and to read its entitlements. A typical integration sends the licence key and optionally the domain to the licence verification endpoint, and receives a response describing whether the licence is active, which edition it belongs to, which plan it was purchased under, and which features are enabled. Products call this at startup, at scheduled intervals, and before enabling premium features, and they cache the validated response for the recommended interval to keep the experience fast and resilient.

How Editions and Plans Fit Together

A product can offer several editions, for example Basic, Standard, and Pro, and each edition can carry one or more pricing plans, for example self-hosted one-time, self-hosted lifetime, hosted monthly, or hosted annual. The marketplace reads this structure to render accurate cards, prices, and checkout options. When a buyer completes a purchase, an order and a licence are created from the selected edition and plan, and the entitlements defined at the edition level are attached to the licence so the product can enforce the right feature set remotely.

Building a Hosted Product

Products listed as hosted must be packaged with the setup steps, requirements, and configuration defaults that the provisioning pipeline needs. Sellers provide the deployment package, the required environment variables, and any post-install steps; our pipeline creates a tenant and a subdomain, deploys the product into an isolated environment, applies the configuration, issues SSL, and hands the buyer a working instance. Buyers manage the instance from their portal and never touch the underlying server.

Self-Hosted Activation

For self-hosted products, the buyer downloads the current version archive from the licence detail page, installs it on their server, and activates the licence key against their domain. The activation binds the licence to that domain and confirms the installed version so the seller can validate legitimate deployments. Sellers publish new versions from their dashboard, and buyers with a qualifying plan receive the latest published archive and the matching release notes.

Notifications and Webhooks

Platform events such as order completion, licence activation, version publication, and support conversation activity generate notifications in-app. Integrations and stores can consume these events to keep their own records in sync, and the API reference documents the payload schemas and authentication for programmatic access. Example requests and error codes are maintained alongside the reference so integrations can be tested against a consistent contract.

Getting Help

If the documentation does not answer your question, the fastest path is usually the product seller through the licence chat, followed by the support team. For platform-wide status, incidents, and maintenance windows, see the API status page, and for community discussion, follow the blog and announcements.