Welcome
Everything you need to run the portal, integrate the SDK, and connect your plugin to the central Admin Module.
This is the complete documentation for your plugin platform. It covers three audiences — customers using the portal, developers integrating the SDK, and operators who self-host and connect deployments to the central Admin Module.
Where to start
Getting Started
Understand the architecture and activate your first license in 5 minutes.
Portal Guide
For customers: accounts, licenses, billing, usage, and team management.
SDK Integration
For developers: validate licenses and report usage from your plugin.
Connect to the Admin Portal
For operators: link this deployment to the central Admin Module.
Reference
Configuration files, environment variables, providers, and the public API.
How the pieces fit together
There are three moving parts. Knowing which is which removes most of the confusion up front:
| Piece | What it is | Who runs it |
|---|---|---|
| Customer Portal | This web app + API. Where your customers sign in, buy plans, and manage license keys. | You (per plugin) |
| The SDK | A small client your plugin embeds to validate licenses and meter usage. | Your customers' installs |
| Admin Module | A separate central dashboard that manages all your plugin deployments at once. | You (once, centrally) |
The Customer Portal exposes four network surfaces. You'll see these referenced throughout the docs:
| Surface | Path | Purpose |
|---|---|---|
| Portal API | /api/rpc/*, /api/rest/* | The signed-in customer app (web/mobile) |
| Public API | /public/* | License validation from plugin installs (no login) |
| Webhooks | /webhooks/* | Inbound billing-provider events |
| Connector | /connector/* | Inbound calls from the central Admin Module |
New here? Read Core Concepts first — it explains each surface and how a license flows from checkout to activation.