License Server

https://github.com/laravel-ready/license-server
Admin
License Server is a Laravel package that provides an agnostic license management system for Laravel...
Tokens:50,881
Snippets:370
Trust Score:7.2
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install via Composer

Source: https://github.com/laravel-ready/license-server/blob/main/README.md

Install the license-server package using Composer.

```bash
composer require laravel-ready/license-server
```

--------------------------------

### Add License Examples

Source: https://github.com/laravel-ready/license-server/blob/main/README.md

Shows how to add licenses to a domain or user, with optional expiration, lifetime, and trial parameters.

```php
// get licensable product
$product = Product::find(1);
$user = User::find(1);

// add license to domain
$license = LicenseService::addLicense($product, 'example.com', $user->id);

// add license to user
$license = LicenseService::addLicense($product, null, $user->id);

// with expiration in days (see configs for defaults)
$license = LicenseService::addLicense($product, null, $user->id, 999);

// with lifetime license (see configs for defaults)
$license = LicenseService::addLicense($product, null, $user->id, null, true);

// with trial license (see configs for defaults)
$license = LicenseService::addLicense($product, null, $user->id, null, false, true);
```

--------------------------------

### LicensableProduct query example

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/support-models.md

Example of querying the pivot by licensable type and id, eager loading license and product relationships, and failing if not found.

```php
use LaravelReady\LicenseServer\Models\LicensableProduct;

$pivot = LicensableProduct::where('licensable_type', Product::class)
    ->where('licensable_id', 1)
    ->with(['license', 'product'])
    ->firstOrFail();
```

--------------------------------

### Example: Admin fetch licenses with search and pagination

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/controllers.md

Example of using the index endpoint with an admin token, searching for 'example.com' and requesting 25 per page. The result is a paginated collection with 'licensedTo' eager-loaded.

```php
use Illuminate\Support\Facades\Http;

$admin = Http::withToken($adminToken)->get('/api/license-server/licenses', [
    'q' => 'example.com',
    'perPage' => 25,
]);

$all = $admin->json('result'); // paginated collection, each row eager-loaded with 'licensedTo'
```

--------------------------------

### Example HTTP request to license endpoint

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/controllers.md

Example of sending a POST request with a license token and custom data, showing the returned license JSON and listener data.

```php
$response = Http::withToken($licenseAccessToken)
    ->post('/api/license-server/license', ['app_version' => '1.2.3']);

// the returned license JSON, e.g.
// { "domain": "example.com", "license_key": "...", "status": "active", ... }
// your 'license_checked' listener receives ['app_version' => '1.2.3'] as $event->data
```

--------------------------------

### Example: eager load all relations

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/license-model.md

Eager loads the `user`, `createdBy`, `ipAddress`, and `licensedTo` relations for a license.

```php
use Illuminate\Support\Facades\DB;
use LaravelReady\LicenseServer\Models\License;

$license = License::with(['user', 'createdBy', 'ipAddress', 'licensedTo'])->find($id);
```

--------------------------------

### IpAddress usage example

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/support-models.md

Shows how to create or update an IpAddress record using updateOrCreate with license_id and ip_address.

```php
use LaravelReady\LicenseServer\Models\IpAddress;

IpAddress::updateOrCreate(
    ['license_id' => $license->id],
    ['ip_address' => $request->ip()]
);
```

--------------------------------

### Example: License serialization

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/license-model.md

Shows how to retrieve a license and inspect its serialized attributes, including `status`, `expires_in`, `is_trial`, and `is_lifetime`.

```php
$license = License::find(1);

// attributes as serialized JSON
$license->toArray();
// includes: status (possibly forced to 'expired'), expires_in, is_trial, is_lifetime
```

--------------------------------

### Example HTTP request to login endpoint

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/controllers.md

Example using Laravel's Http facade to POST to the login endpoint with headers and license_key. Checks response and extracts access_token or error message.

```php
use Illuminate\Support\Facades\Http;

$response = Http::withHeaders([
    'accept' => 'application/json',
    'x-host' => 'https://app.example.com',
    'x-host-name' => 'app.example.com',
])->post(config('app.url') . '/api/license-server/auth/login', [
    'license_key' => '46fad906-bc51-435f-9929-db46cb4baf13',
]);

if ($response->ok()) {
    $token = $response->json('access_token');
} else {
    $message = $response->json('message'); // 'Invalid license key or lincese source.' | 'This IP address is not allowed...'
}
```

--------------------------------

### Catching LicenseException

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/errors.md

Example try-catch block for LicenseException, showing all possible messages and using report() to log them.

```php
use LaravelReady\LicenseServer\Exceptions\LicenseException;
use LaravelReady\LicenseServer\Services\LicenseService;

try {
    $license = LicenseService::addLicense($product, 'example.com', $user->id);
} catch (LicenseException $e) {
    // 'Given model is not licensable.'
    // 'License already exists for this domain.'
    // 'Domain or user id must be provided.'
    // 'Failed to create license with product model.'
    report($e->getMessage());
}
```

--------------------------------

### Example request with x-host headers

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/middleware.md

Shows a POST request to the login endpoint with x-host and x-host-name headers, and checks for a 403 response indicating missing headers or unresolvable domain.

```php
$response = Http::withHeaders([
    'x-host' => 'https://app.example.com',
    'x-host-name' => 'app.example.com',
])->post('/api/license-server/auth/login', $payload);

if ($response->status() === 403) {
    // missing headers, or host does not resolve against the IANA TLD list
}
```

--------------------------------

### getLicenseByKey usage example

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/license-service.md

Retrieves a license by its UUID key. Returns null if the key is not a valid UUID or no matching license is found.

```php
use LaravelReady\LicenseServer\Services\LicenseService;

$license = LicenseService::getLicenseByKey('46fad906-bc51-435f-9929-db46cb4baf13');

if ($license) {
    echo $license->domain;
} else {
    // key not found or malformed
}
```

--------------------------------

### Example: HTTP request with bad token expecting 403

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/middleware.md

Shows how to test the middleware by sending a request with a token that lacks the 'license-access' ability, expecting a 403 response.

```php
$response = Http::withToken($badToken)->post('/api/license-server/license');

if ($response->status() === 403) {
    // token missing the license-access ability, or no authenticated license
}
```

--------------------------------

### GET /api/license-server/licenses

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/endpoints.md

Lists licenses with optional search and pagination. Returns a paginated list of licenses eager-loaded with licensedTo.product.

```APIDOC
## [GET] /api/license-server/licenses

### Description
Lists licenses with optional search and pagination. Returns a paginated list of licenses eager-loaded with licensedTo.product.

### Method
GET

### Endpoint
/api/license-server/licenses

### Parameters
#### Query Parameters
- **q** (string) - Optional - Free-text `LIKE %q%` search against the `domain` column
- **perPage** (int) - Optional - Page size; values above 100 are clamped to 100 (default: 15)

### Response
#### Success Response (200)
- **success** (boolean) - Always true
- **result** (object) - Paginated data object containing:
  - **data** (array) - License rows, eager-loaded with licensedTo.product
  - **path** (string) - Base path for pagination
  - **per_page** (int) - Items per page
  - **next_page_url** (string|null) - URL for next page
  - **prev_page_url** (string|null) - URL for previous page

#### Response Example
```json
{
  "success": true,
  "result": {
    "data": [ { "...": "license row, eager-loaded with licensedTo.product" } ],
    "path": "...", "per_page": 15, "next_page_url": "...", "prev_page_url": null
  }
}
```
```

--------------------------------

### Example override file (config/license-server.php)

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/configuration.md

Published configuration file for the license server package. Sets default table prefix, domain validation options, license expiration, trial settings, middleware, event listeners, controllers, and custom license middlewares. All values are read through Laravel's config repository.

```php
<?php

// config/license-server.php (published)
return [
    'default_table_prefix' => 'ls',

    'allow_subdomains' => false,              // only registrable domains
    'license_expiration_days' => 90,
    'allow_lifetime_licenses' => true,
    'allow_trial_licenses' => true,
    'trial_expiration_days' => 14,

    'admin_api_middleware' => [
        'auth:sanctum',
        'throttle:api',
    ],

    'event_listeners' => [
        'license_checked' => App\Listeners\LicenseCheckedListener::class,
    ],

    'controllers' => [
        'license_validation' => [
            App\Http\Controllers\LicenseController::class,
            'licenseValidate',
        ],
    ],

    'license_middlewares' => [
        'myapp.log-license-checks',
    ],
];
```

--------------------------------

### GET /api/license-server/licenses - 200 OK response

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/endpoints.md

Response for listing licenses with pagination. Uses simplePaginate() so no total-count keys are present. The 'data' array contains license rows eager-loaded with licensedTo.product.

```json
{
  "success": true,
  "result": {
    "data": [ { "...": "license row, eager-loaded with licensedTo.product" } ],
    "path": "...", "per_page": 15, "next_page_url": "...", "prev_page_url": null
  }
}
```

--------------------------------

### Runtime override (config(['license-server.allow_subdomains' => false]))

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/configuration.md

Sets a configuration value at runtime, useful for tests or dynamic behavior. After setting, the LicenseService::validateDomain method uses the updated value; the example shows it returning 'example.com' for a subdomain when subdomains are disallowed.

```php
config(['license-server.allow_subdomains' => false]);

$result = LicenseService::validateDomain('sub.example.com'); // 'example.com'
```

--------------------------------

### GET /api/license-server/licenses/{license}

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/endpoints.md

Retrieves a single license by its ID. Returns the full License model.

```APIDOC
## [GET] /api/license-server/licenses/{license}

### Description
Retrieves a single license by its ID. Returns the full License model.

### Method
GET

### Endpoint
/api/license-server/licenses/{license}

### Parameters
#### Path Parameters
- **license** (int) - Required - The ID of the license (route-model-bound)

### Response
#### Success Response (200)
- **success** (boolean) - Always true
- **result** (object) - Full License model

#### Response Example
```json
{ "success": true, "result": { "...": "full License model" } }
```

#### Error Response (404)
- **message** (string) - Model not found
```

--------------------------------

### GET /api/license-server/licenses

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/controllers.md

Lists licenses with optional search and pagination. Returns a paginated collection of licenses eager-loaded with their licensedTo relationship.

```APIDOC
## [GET] /api/license-server/licenses

### Description
Lists licenses with optional search and pagination. Returns a paginated collection of licenses eager-loaded with their licensedTo relationship.

### Method
GET

### Endpoint
/api/license-server/licenses

### Parameters
#### Query Parameters
- **q** (string) - Optional - Free-text search on `domain` (like query).
- **perPage** (integer) - Optional - Page size, clamped to 100, default 15.

### Request Example
```
GET /api/license-server/licenses?q=example.com&perPage=25
```

### Response
#### Success Response (200)
- **success** (boolean) - Always `true`.
- **result** (paginator) - Paginated collection of licenses, each eager-loaded with `licensedTo`.

#### Response Example
```json
{
  "success": true,
  "result": { "data": [ /* License objects */ ], "pagination": { } }
}
```
```

--------------------------------

### Example: setLicenseStatus with suspended status

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/license-service.md

Calls setLicenseStatus with a UUID key and 'suspended' status, then checks if the returned license is not null to confirm the update. The method writes the given status without whitelist validation.

```php
$license = LicenseService::setLicenseStatus('46fad906-bc51-435f-9929-db46cb4baf13', 'suspended');

if ($license !== null) {
    // updated
}
```

--------------------------------

### LicenseChecked listener example

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/events.md

A listener class that handles the LicenseChecked event, logging the license key and payload. It is registered via the 'license-server.event_listeners.license_checked' config.

```php
<?php

namespace App\Listeners;

use LaravelReady\LicenseServer\Events\LicenseChecked;

class LicenseCheckedListener
{
    public function handle(LicenseChecked $event)
    {
        // $event->license, $event->data
        logger()->info('License used', [
            'key' => $event->license->license_key,
            'payload' => $event->data,
        ]);
    }
}
```

--------------------------------

### GET /api/license-server/licenses/{license} - 200 OK response

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/endpoints.md

Response for showing a single license. The 'result' contains the full License model. Returns 404 Not Found if the id does not exist.

```json
{ "success": true, "result": { "...": "full License model" } }
```

--------------------------------

### getLicenseByUserId usage example

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/license-service.md

Retrieves the lowest-id license for a user, optionally filtered by a UUID key. Returns null if the key is not a valid UUID or no matching license is found.

```php
$license = LicenseService::getLicenseByUserId(42);

// with key filter
$license = LicenseService::getLicenseByUserId(42, '46fad906-bc51-435f-9929-db46cb4baf13');
```

--------------------------------

### getLicenseByDomain signature and usage

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/license-service.md

Defines the static method getLicenseByDomain that returns a License or null. The domain is validated first; an invalid domain or non-UUID license key yields null. Example calls show usage with and without a license key.

```php
/**
 * Get license by domain.
 *
 * @param string $domain
 * @param string $licenseKey
 *
 * @return null | License
 */
public static function getLicenseByDomain(string $domain, string $licenseKey = null): null | License
```

```php
$license = LicenseService::getLicenseByDomain('example.com');
$license = LicenseService::getLicenseByDomain('example.com', '46fad906-bc51-435f-9929-db46cb4baf13');
```

--------------------------------

### checkLicenseStatus signature and usage

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/license-service.md

Defines the static method checkLicenseStatus that returns a status string. The method returns 'invalid-license-key' for non-UUID keys, 'no-license-found' if no matching row, 'expired' if expiration date is past, or the raw status column value. The example shows a switch statement handling each possible status.

```php
/**
 * Check if license is valid.
 * Returns "active", "inactive", "suspended", "expired", "invalid-license-key" and "no-license-found"
 *
 * @param string $domain
 * @param string $licenseKey
 *
 * @return string
 */
public static function checkLicenseStatus(string $licenseKey)
```

```php
$status = LicenseService::checkLicenseStatus('46fad906-bc51-435f-9929-db46cb4baf13');

switch ($status) {
    case 'active':
        // license is fine
        break;
    case 'expired':
    case 'suspended':
    case 'inactive':
        // deny
        break;
    case 'invalid-license-key':
    case 'no-license-found':
        // unknown key
        break;
}
```

--------------------------------

### Basic use - create a license

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/facade.md

Creates a license for a product and domain using the facade. Requires a Product model instance.

```php
use LaravelReady\LicenseServer\Facades\LicenseServer;

$product = Product::find(1);
$license = LicenseServer::addLicense($product, 'example.com', 1);
```

--------------------------------

### Publish and Apply Migrations

Source: https://github.com/laravel-ready/license-server/blob/main/README.md

Publish the package migrations and then apply them to the database.

```bash
# publish migrations
php artisan vendor:publish --tag=license-server-migrations

# apply migrations
php artisan migrate --path=/database/migrations/laravel-ready/license-server
```

--------------------------------

### GET /api/license-server/licenses

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/endpoints.md

Lists all licenses. This endpoint is used by administrators to view the list of licenses.

```APIDOC
## GET /api/license-server/licenses

### Description
Lists all licenses. This endpoint is used by administrators to view the list of licenses.

### Method
GET

### Endpoint
/api/license-server/licenses

### Parameters
#### Query Parameters
- No query parameters are documented.

### Response
#### Success Response (200)
- **licenses** (array) - List of license objects.

#### Response Example
{
  "licenses": []
}
```

--------------------------------

### LicensableProduct boot() method

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/support-models.md

Static boot method registers a saving event that overwrites user_id with the authenticated user id (or null) on every save.

```php
public static function boot()
{
    parent::boot();

    static::saving(function ($model) {
        $model->user_id = auth()->id() ?? null;
    });
}
```

--------------------------------

### Using LicenseServer facade with import

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/facade.md

Shows how to call a static method on the facade after importing it. The facade forwards to LicenseService::checkLicenseStatus().

```php
use LaravelReady\LicenseServer\Facades\LicenseServer;

$status = LicenseServer::checkLicenseStatus('46fad906-bc51-435f-9929-db46cb4baf13');
```

--------------------------------

### Publish Configs

Source: https://github.com/laravel-ready/license-server/blob/main/README.md

Publish the package configuration file for customization.

```bash
# publish configs
php artisan vendor:publish --tag=license-server-configs
```

--------------------------------

### Create LicenseCheckedListener with Artisan Command

Source: https://github.com/laravel-ready/license-server/blob/main/README.md

Run this Artisan command to generate a listener class for the LicenseChecked event. The listener will be created in the App\Listeners namespace.

```bash
php artisan make:listener LicenseCheckedListener --event=LicenseChecked
```

--------------------------------

### GET /api/license-server/licenses/{license}

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/endpoints.md

Shows a single license. This endpoint is used by administrators to view details of a specific license.

```APIDOC
## GET /api/license-server/licenses/{license}

### Description
Shows a single license. This endpoint is used by administrators to view details of a specific license.

### Method
GET

### Endpoint
/api/license-server/licenses/{license}

### Parameters
#### Path Parameters
- **license** (integer) - Required - The ID of the license.

### Response
#### Success Response (200)
- **license** (object) - The license object.

#### Response Example
{
  "license": {}
}
```

--------------------------------

### boot() signature

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/service-providers.md

Boot method signature that delegates to the framework's EventServiceProvider::boot().

```php
public function boot()
{
    parent::boot();
}
```

--------------------------------

### Basic usage of LicenseService::addLicense

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/license-service.md

Shows how to create domain, user, lifetime, and trial licenses. Requires a model using the Licensable trait and a user ID. Lifetime and trial licenses depend on config flags.

```php
use LaravelReady\LicenseServer\Services\LicenseService;

$product = Product::find(1); // a model using the Licensable trait
$user = User::find(1);

// domain license bound to user 1
$license = LicenseService::addLicense($product, 'example.com', $user->id);

// user license (no domain) with a 999-day expiration
$license = LicenseService::addLicense($product, null, $user->id, 999);

// lifetime license
$license = LicenseService::addLicense($product, null, $user->id, null, true);

// trial license
$license = LicenseService::addLicense($product, null, $user->id, null, false, true);
```

--------------------------------

### Subclass overriding authorize() to delegate to policy

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/requests.md

Example subclass that overrides authorize() to check a policy. Map via route-level binding since the controller type-hints LicenseUpdateRequest.

```php
<?php

namespace App\Http\Requests;

use LaravelReady\LicenseServer\Http\Requests\LicenseUpdateRequest;

class UpdateLicenseRequest extends LicenseUpdateRequest
{
    public function authorize(): bool
    {
        return $this->user()->can('update', $this->route('license'));
    }
}
```

--------------------------------

### LicenseService::addLicense

Source: https://github.com/laravel-ready/license-server/blob/main/README.md

Adds a new license for a product, either to a domain or a user. Returns a License model instance.

```APIDOC
## LicenseService::addLicense

### Description
Adds a new license for a product, either to a domain or a user. Returns a License model instance.

### Method
Service Method

### Signature
`LicenseService::addLicense($product, $domain, $userId, $expirationDays = null, $isLifetime = false, $isTrial = false)`

### Parameters
- **$product** (Model) - Required - The licensable product model instance.
- **$domain** (string|null) - Optional - The domain to license. If provided, license is domain-based.
- **$userId** (int|null) - Required if domain is null - The user ID to license. If domain is null, this is required.
- **$expirationDays** (int|null) - Optional - Number of days until expiration. Defaults from config.
- **$isLifetime** (bool) - Optional - Whether the license is lifetime. Defaults from config.
- **$isTrial** (bool) - Optional - Whether the license is a trial. Defaults from config.

### Request Example
```php
$license = LicenseService::addLicense($product, 'example.com', $user->id);
$license = LicenseService::addLicense($product, null, $user->id, 999);
$license = LicenseService::addLicense($product, null, $user->id, null, true);
$license = LicenseService::addLicense($product, null, $user->id, null, false, true);
```

### Response
Returns `LaravelReady\LicenseServer\Models\License` model instance.
```

--------------------------------

### register method implementation

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/service-providers.md

Registers configs, binds the license-server singleton to a new LicenseService, and registers the EventServiceProvider.

```php
public function register(): void
{
    $this->registerConfigs();

    $this->app->singleton('license-server', function () {
        return new LicenseService();
    });

    $this->app->register(EventServiceProvider::class);
}
```

--------------------------------

### Basic usage of DomainSupport::validateDomain

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/domain-support.md

Example of validating a URL and extracting the subdomain and registrable domain. The returned Pdp\ResolvedDomain object provides subDomain()->toString() and registrableDomain()->toString().

```php
use LaravelReady\LicenseServer\Support\DomainSupport;

$domain = DomainSupport::validateDomain('https://sub.example.com/path');

$sub = $domain->subDomain()->toString();       // 'sub'
$reg = $domain->registrableDomain()->toString(); // 'example.com'
```

--------------------------------

### Container binding for license-server singleton

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/facade.md

Registers the 'license-server' singleton in the service provider, returning a new LicenseService instance.

```php
$this->app->singleton('license-server', function () {
    return new LicenseService();
});
```

--------------------------------

### License validation flow

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/controllers.md

Selects license columns by the authenticated user's id, gets request input, dispatches LicenseChecked event, and returns the license model.

```php
$_license = $license->select(
    'domain',
    'license_key',
    'status',
    'expiration_date',
    'is_trial',
    'is_lifetime',
    'deleted_at',
    'created_at',
    'updated_at'
)->where('id', auth()->user()->id)->first();

$data = $request->input();

Event::dispatch(new LicenseChecked($_license, $data));

return $_license;
```

--------------------------------

### License boot method with saving hook

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/license-model.md

Registers a 'saving' event that overwrites 'created_by' with auth()->id() on every save. May set null when unauthenticated.

```php
public static function boot()
{
    parent::boot();

    static::saving(function ($model) {
        $model->created_by = auth()->id();
    });
}
```

--------------------------------

### Error handling with LicenseException

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/facade.md

Catches LicenseException thrown by delegated methods. The exception message may be 'License already exists for this domain.'.

```php
use LaravelReady\LicenseServer\Exceptions\LicenseException;

try {
    LicenseServer::addLicense($product, 'example.com', 1);
} catch (LicenseException $e) {
    // 'License already exists for this domain.' etc.
}
```

--------------------------------

### LicenseGuardMiddleware handle() method

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/middleware.md

Checks that the authenticated user (a License model) has a token with the 'license-access' ability. Passes the request to the next middleware if true, otherwise aborts with HTTP 403.

```php
public function handle(Request $request, Closure $next)
{
    if (auth()->user() && auth()->user()->tokenCan('license-access')) {
        return $next($request);
    }

    return abort(403);
}
```

--------------------------------

### Using LicenseServer facade without import

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/facade.md

With auto-discovery, the facade alias can be used without a use statement. Calls LicenseService::getLicenseByKey().

```php
$license = LicenseServer::getLicenseByKey('46fad906-bc51-435f-9929-db46cb4baf13');
```

--------------------------------

### Catch ListenerNotFoundException during manual app boot

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/errors.md

Use this try/catch when booting the application manually (e.g., in tests or console bootstrap scripts) to handle the ListenerNotFoundException thrown during service-provider registration. In normal Laravel boot, fix the configuration instead of catching.

```php
try {
    $app->register(LaravelReady\LicenseServer\EventServiceProvider::class);
} catch (LaravelReady\LicenseServer\Exceptions\ListenerNotFoundException $e) {
    // only meaningful when booting the app manually,
    // e.g. in tests or console bootstrap scripts
    $this->fail('Fix license-server.event_listeners.license_checked.');
}
```

--------------------------------

### LicenseServer facade class declaration

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/facade.md

Declares the LicenseServer facade that proxies the 'license-server' singleton. The getFacadeAccessor method returns the container binding key.

```php
class LicenseServer extends Facade
{
    protected static function getFacadeAccessor()
    {
        return 'license-server';
    }
}
```

--------------------------------

### Resolving the singleton directly

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/facade.md

Resolves the 'license-server' singleton from the container and calls a static method on it. The instance is shared across the application lifecycle.

```php
$service = app('license-server');

$status = $service::checkLicenseStatus('46fad906-bc51-435f-9929-db46cb4baf13');
```

--------------------------------

### __construct($app) signature

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/service-providers.md

Constructor signature for EventServiceProvider. Called during LicenseServerServiceProvider::register().

```php
public function __construct($app)
```

--------------------------------

### boot method signature

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/service-providers.md

Signature of the boot method that performs boot-time actions: publishes configs and migrations, loads routes, registers middleware aliases, and checks TLD cache.

```php
public function boot(Router $router): void
```

--------------------------------

### LicenseServerServiceProvider class definition

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/service-providers.md

Defines the main service provider with boot and register methods. Boot publishes configs and migrations, loads routes, registers middleware aliases, and checks TLD cache. Register merges configs, binds the license-server singleton, and registers EventServiceProvider.

```php
final class LicenseServerServiceProvider extends ServiceProvider
{
    public function boot(Router $router): void
    {
        $this->bootPublishes();

        $this->loadRoutes();

        $this->loadMiddlewares($router);

        DomainSupport::checkTldCache();
    }

    public function register(): void
    {
        $this->registerConfigs();

        $this->app->singleton('license-server', function () {
            return new LicenseService();
        });

        $this->app->register(EventServiceProvider::class);
    }
    ...
}
```

--------------------------------

### DomainGuardMiddleware handle method

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/middleware.md

Resolves the client domain from x-host and x-host-name headers, merges it as 'ls_domain', and aborts with 403 if headers are missing or domain cannot be resolved.

```php
public function handle(Request $request, Closure $next)
{
    $host = $request->header('x-host');
    $hostName = $request->header('x-host-name');

    if ($host && $hostName) {
        $domain = DomainSupport::validateDomain($host);
        $subDomain = $domain->subDomain()->toString();

        if (Config::get('license-server.allow_subdomains') && !empty($subDomain)) {
            $request->merge([
                'ls_domain' => $subDomain,
            ]);

            return $next($request);
        }

        $registrableDomain = $domain->registrableDomain()->toString();

        if (!empty($registrableDomain)) {
            $request->merge([
                'ls_domain' => $registrableDomain,
            ]);

            return $next($request);
        }
    }

    return abort(403);
}
```

--------------------------------

### LicenseService::getLicenseByKey

Source: https://github.com/laravel-ready/license-server/blob/main/README.md

Retrieves a license by its license key.

```APIDOC
## LicenseService::getLicenseByKey

### Description
Retrieves a license by its license key.

### Method
Service Method

### Signature
`LicenseService::getLicenseByKey(string $licenseKey)`

### Parameters
- **$licenseKey** (string) - Required - The license key in UUID format.

### Request Example
```php
$license = LicenseService::getLicenseByKey('46fad906-bc51-435f-9929-db46cb4baf13');
```

### Response
Returns the license model or null.
```

--------------------------------

### 200 OK response

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/endpoints.md

Returned on successful login. The access_token is the second segment after splitting plainTextToken on '|' and carries the 'license-access' ability. Existing tokens with the same token name (the domain) are deleted first.

```json
{
  "status": true,
  "message": "Successfully logged in.",
  "access_token": "1|hash-onf96hz0..."
}
```

--------------------------------

### Register LicenseCheckedListener in config/license-server.php

Source: https://github.com/laravel-ready/license-server/blob/main/README.md

Add the listener to the 'event_listeners' array in the license-server configuration file. The 'license_checked' key maps to the listener class, allowing custom data handling when a license is checked.

```php
/**
    * Event listeners for License Server
    */
'event_listeners' => [
    /**
        * License checked event listener
        *
        * You can use this event to do something when a license is checked.
        * Also you can handle custom data with this listener.
        *
        * See the documentation for more information.
        *
        * Default: null
        */
    'license_checked' => App\Listeners\LicenseCheckedListener::class,
],
```

--------------------------------

### IpAddress constructor

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/support-models.md

Constructor sets table name dynamically using config prefix 'theme-store.default_table_prefix' (default 'ls'), resulting in '{prefix}_ip_addresses'.

```php
public function __construct(array $attributes = [])
{
    $prefix = Config::get('theme-store.default_table_prefix', 'ls');

    $this->table = "{$prefix}_ip_addresses";

    parent::__construct($attributes);
}
```

--------------------------------

### LicenseServer::getLicenseByDomain($domain, $key)

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/facade.md

Retrieves a license by domain and key through the LicenseService. This method is called statically on the facade and delegates to LicenseService::getLicenseByDomain().

```APIDOC
## LicenseServer::getLicenseByDomain($domain, $key)

### Description
Retrieves a license by domain and key through the LicenseService. This method is called statically on the facade and delegates to LicenseService::getLicenseByDomain().

### Method
Facade static method

### Endpoint
LicenseServer::getLicenseByDomain($domain, $key)

### Parameters
- **$domain** (string) - Required - The domain.
- **$key** (string) - Required - The license key.

### Response
Returns the license object.
```

--------------------------------

### LicenseService::getLicenseByDomain

Source: https://github.com/laravel-ready/license-server/blob/main/README.md

Retrieves a license by domain and optionally a license key.

```APIDOC
## LicenseService::getLicenseByDomain

### Description
Retrieves a license by domain and optionally a license key.

### Method
Service Method

### Signature
`LicenseService::getLicenseByDomain(string $domain, string $licenseKey = null)`

### Parameters
- **$domain** (string) - Required - The domain.
- **$licenseKey** (string|null) - Optional - The license key in UUID format.

### Request Example
```php
$license = LicenseService::getLicenseByDomain('example.com');
$license = LicenseService::getLicenseByDomain('example.com', '46fad906-bc51-435f-9929-db46cb4baf13');
```

### Response
Returns the license model or null.
```

--------------------------------

### Set Table Prefix in Config

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/configuration.md

Shows the configuration keys for setting a custom table prefix. The 'license-server' key is used by configs and migrations, while the 'theme-store' key is read by the models. Both must be set to the same value to avoid table mismatches.

```php
'default_table_prefix'   => 'myapp',  // license-server key
// and publish/merge an extra entry — the models read the theme-store key:
'theme-store' => [
    'default_table_prefix' => 'myapp',
],
```

--------------------------------

### LicenseServer::checkLicenseStatus($key)

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/facade.md

Checks the status of a license by key through the LicenseService. This method is called statically on the facade and delegates to LicenseService::checkLicenseStatus().

```APIDOC
## LicenseServer::checkLicenseStatus($key)

### Description
Checks the status of a license by key through the LicenseService. This method is called statically on the facade and delegates to LicenseService::checkLicenseStatus().

### Method
Facade static method

### Endpoint
LicenseServer::checkLicenseStatus($key)

### Parameters
- **$key** (string) - Required - The license key.

### Request Example
```php
$status = LicenseServer::checkLicenseStatus('46fad906-bc51-435f-9929-db46cb4baf13');
```

### Response
Returns the license status.
```

--------------------------------

### POST /api/license-server/licenses

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/controllers.md

Not implemented. Always returns a failure message indicating that licenses cannot be created directly and must be created via the service class.

```APIDOC
## [POST] /api/license-server/licenses

### Description
Not implemented. Always returns a failure message indicating that licenses cannot be created directly and must be created via the service class.

### Method
POST

### Endpoint
/api/license-server/licenses

### Response
#### Success Response (200)
- **success** (boolean) - Always `false`.
- **result** (string) - Message: "You can not create a new license directly. Please use service class."

#### Response Example
```json
{
  "success": false,
  "result": "You can not create a new license directly. Please use service class."
}
```
```

--------------------------------

### LicensableProduct constructor

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/support-models.md

Constructor sets the table name to "{prefix}_licensable_products" using 'theme-store.default_table_prefix' (default 'ls'). Note the quirk: migrations use 'license-server.default_table_prefix' instead.

```php
public function __construct(array $attributes = [])
{
    $prefix = Config::get('theme-store.default_table_prefix', 'ls');

    $this->table = "{$prefix}_licensable_products";

    parent::__construct($attributes);
}
```

--------------------------------

### POST /api/license-server/licenses

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/endpoints.md

Not implemented. Returns a success response indicating that licenses cannot be created directly.

```APIDOC
## [POST] /api/license-server/licenses

### Description
Not implemented. Returns a success response indicating that licenses cannot be created directly.

### Method
POST

### Endpoint
/api/license-server/licenses

### Response
#### Success Response (200)
- **success** (boolean) - Always false
- **result** (string) - Message: "You can not create a new license directly. Please use service class."

#### Response Example
```json
{ "success": false, "result": "You can not create a new license directly. Please use service class." }
```
```

--------------------------------

### LicenseServer::getLicenseByKey($key)

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/facade.md

Retrieves a license by its key through the LicenseService. This method is called statically on the facade and delegates to LicenseService::getLicenseByKey().

```APIDOC
## LicenseServer::getLicenseByKey($key)

### Description
Retrieves a license by its key through the LicenseService. This method is called statically on the facade and delegates to LicenseService::getLicenseByKey().

### Method
Facade static method

### Endpoint
LicenseServer::getLicenseByKey($key)

### Parameters
- **$key** (string) - Required - The license key.

### Request Example
```php
$license = LicenseServer::getLicenseByKey('46fad906-bc51-435f-9929-db46cb4baf13');
```

### Response
Returns the license object.
```

--------------------------------

### Publish License Server Config

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/configuration.md

Publishes the package configuration file to the application's config directory for customization.

```bash
php artisan vendor:publish --tag=license-server-configs
```

--------------------------------

### Usage of licensed() to check licensing

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/licensable-trait.md

Shows how to eager-load the licensed relation and check if a product is licensed, outputting the user id.

```php
$product = Product::with('licensed')->find(1);

if ($product->licensed) {
    echo "Licensed to user id: {$product->licensed->user_id}";
}
```

--------------------------------

### LicenseServer::addLicense(...)

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/facade.md

Adds a new license through the LicenseService. This method is called statically on the facade and delegates to LicenseService::addLicense().

```APIDOC
## LicenseServer::addLicense(...)

### Description
Adds a new license through the LicenseService. This method is called statically on the facade and delegates to LicenseService::addLicense().

### Method
Facade static method

### Endpoint
LicenseServer::addLicense(...)

### Parameters
- **$product** - Required - The product for which the license is created.
- **$domain** (string) - Required - The domain associated with the license.
- **$userId** (int) - Required - The user ID associated with the license.

### Request Example
```php
$product = Product::find(1);
$license = LicenseServer::addLicense($product, 'example.com', 1);
```

### Response
Returns the created license object.

### Error Handling
Throws LicenseException if the license already exists for the domain.
```

--------------------------------

### LicensableProduct class declaration

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/support-models.md

Full Eloquent model for the polymorphic pivot binding a license to any product model. Constructor sets table name from 'theme-store.default_table_prefix' (default 'ls'), boot() overwrites user_id on saving, and relationships include license() BelongsTo and product() morphTo.

```php
class LicensableProduct extends Model
{
    public function __construct(array $attributes = [])
    {
        $prefix = Config::get('theme-store.default_table_prefix', 'ls');

        $this->table = "{$prefix}_licensable_products";

        parent::__construct($attributes);
    }

    public static function boot()
    {
        parent::boot();

        static::saving(function ($model) {
            $model->user_id = auth()->id() ?? null;
        });
    }

    protected $table = 'ls__licensable_products';

    protected $fillable = [
        'licensable_id',
        'licensable_type',
        'license_id',
        'user_id',
    ];

    protected $casts = [];

    protected $dates = [
        'updated_at',
        'deleted_at',
    ];

    protected $appends = [];

    public function license(): BelongsTo
    {
        return $this->belongsTo(License::class);
    }

    public function product()
    {
        return $this->morphTo(__FUNCTION__, 'licensable_type', 'licensable_id');
    }
}
```

--------------------------------

### IpAddress class declaration

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/support-models.md

Full model class with dynamic table prefix from config 'theme-store.default_table_prefix' (default 'ls'), fillable fields, casts, dates, appends, and license relationship.

```php
class IpAddress extends Model
{
    public function __construct(array $attributes = [])
    {
        $prefix = Config::get('theme-store.default_table_prefix', 'ls');

        $this->table = "{$prefix}_ip_addresses";

        parent::__construct($attributes);
    }

    protected $table = 'ls_ip_addresses';

    protected $fillable = [
        'license_id',
        'ip_address',
    ];

    protected $casts = [];

    protected $dates = [
        'updated_at',
        'deleted_at',
    ];

    protected $appends = [];

    public function license(): BelongsTo
    {
        return $this->belongsTo(License::class);
    }
}
```

--------------------------------

### POST /api/license-server/auth/login

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/controllers.md

Authenticates a client (license-connector) by presenting a license key and domain. On success, returns a Sanctum token with the 'license-access' ability.

```APIDOC
## [POST] /api/license-server/auth/login

### Description
Authenticates a client (license-connector) by presenting a license key and domain. On success, returns a Sanctum token with the 'license-access' ability.

### Method
POST

### Endpoint
/api/license-server/auth/login

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **license_key** (string, UUID) - Required - The license key to authenticate with.
- **ls_domain** (string) - Optional - The domain name, injected by middleware from headers.

#### Headers
- **x-host** (string) - Required - The host URL, consumed by DomainGuardMiddleware.
- **x-host-name** (string) - Required - The host name, consumed by DomainGuardMiddleware.

### Request Example
```json
{
  "license_key": "46fad906-bc51-435f-9929-db46cb4baf13"
}
```

### Response
#### Success Response (200)
- **status** (boolean) - Indicates success.
- **message** (string) - Success message.
- **access_token** (string) - The Sanctum token.

#### Response Example
```json
{
  "status": true,
  "message": "Successfully logged in.",
  "access_token": "<token-segment-after-the-first-|>"
}
```

#### Error Response (401)
- **status** (boolean) - Indicates failure.
- **message** (string) - Error message.

#### Error Example
```json
{
  "status": false,
  "message": "This IP address is not allowed. Please contact the license provider."
}
```

```json
{
  "status": false,
  "message": "Invalid license key or lincese source."
}
```
```

--------------------------------

### addLicense method signature

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/api-reference/license-service.md

Static method to add a license to a given domain or user. Returns null or License. Throws LicenseException for invalid model, duplicate domain, missing domain/user, or pivot attach failure.

```php
/**
 * Add license to the given domain.
 *
 * @param string $domain
 * @param object $licensableModel
 * @param int $expirationDays
 * @param bool $idLifetime
 * @param bool $isTrial
 * @param int $userId
 *
 * @return null | License
 */
public static function addLicense(
    object $licensableModel,
    string $domain = null,
    int $userId = null,
    int $expirationDays = null,
    bool $isLifetime = false,
    bool $isTrial = false,
): null | License {
```

--------------------------------

### POST /api/license-server/licenses - 200 OK response

Source: https://github.com/laravel-ready/license-server/blob/main/_autodocs/endpoints.md

Response when attempting to create a license directly. The endpoint is not implemented and returns this message instructing to use the service class.

```json
{ "success": false, "result": "You can not create a new license directly. Please use service class." }
```

--------------------------------

### LicenseService::checkLicenseStatus

Source: https://github.com/laravel-ready/license-server/blob/main/README.md

Checks the status of a license by its key.

```APIDOC
## LicenseService::checkLicenseStatus

### Description
Checks the status of a license by its key.

### Method
Service Method

### Signature
`LicenseService::checkLicenseStatus(string $licenseKey)`

### Parameters
- **$licenseKey** (string) - Required - The license key in UUID format.

### Request Example
```php
$licenseStatus = LicenseService::checkLicenseStatus('46fad906-bc51-435f-9929-db46cb4baf13');
```

### Response
Returns one of: "active", "inactive", "suspended", "expired", "invalid-license-key", "no-license-found".
```
Tokens:
Raw