Skip to content

API Reference

LicenseDock provides a REST API for license management, update checks, and secure downloads.

Base URL

https://yoursite.com/api/index.php/v1/licensedock/

Authentication

All endpoints authenticate using the license_key included in the request. No additional setup needed.

Response Format

Success

json
{
  "data": {
    "key": "value"
  }
}

Error

json
{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable description"
  }
}

Error Codes

CodeDescription
INVALID_REQUESTMissing or invalid parameters
LICENSE_NOT_FOUNDLicense key doesn't exist
LICENSE_INACTIVELicense exists but is not active
LICENSE_EXPIREDLicense has expired
ACTIVATION_LIMIT_REACHEDMaximum activations reached
ACTIVATION_NOT_FOUNDActivation identifier not found
PRODUCT_MISMATCHLicense doesn't match the requested product
DOWNLOAD_NOT_FOUNDNo download available
FILE_NOT_FOUNDDownload file missing from server

Conventions

  • Dates are ISO 8601 format: 2026-03-20T03:21:26Z
  • Absent values are null, not empty strings
  • All responses use Content-Type: application/json

Endpoints

MethodEndpointDescription
POST/licenses/activateActivate a license
POST/licenses/deactivateDeactivate a license
POST/licenses/validateValidate a license
GET/updates/:product_idCheck for updates
GET/downloads/:product_idDownload a product file

Joomla Extensions by Contona