Complete API Reference

All API requests require authentication using your API key in the Authorization header:

API requests are rate limited to ensure fair usage:

• 1000 requests per hour
• 100 requests per minute
• Burst limit: 10 requests per second

Rate limit information is included in response headers:

• X-RateLimit-Limit-Hourly - Hourly limit
• X-RateLimit-Remaining-Hourly - Remaining requests this hour
• X-RateLimit-Reset-Hourly - Unix timestamp when limit resets
• Similar headers for Minute and Second

POST /v1/auth/register

Register a new user account.

{
  "email": "user@example.com",
  "password": "securepassword",
  "name": "John Doe"
}

{
  "id": "user_id",
  "email": "user@example.com",
  "name": "John Doe",
  "token": "jwt_token_here"
}

POST /v1/auth/login

Login with email and password.

{
  "email": "user@example.com",
  "password": "securepassword"
}

{
  "id": "user_id",
  "email": "user@example.com",
  "name": "John Doe",
  "token": "jwt_token_here"
}

GET /v1/auth/me

Get current authenticated user information.

Requires: Authentication

{
  "id": "user_id",
  "email": "user@example.com",
  "name": "John Doe",
  "tier": "pro",
  "role": "user"
}

GET /v1/apps

List all applications for the authenticated user.

Requires: Authentication

{
  "apps": [
    {
      "id": "app_id",
      "name": "My App",
      "slug": "my-app",
      "description": "App description",
      "apiKey": "api_key_here",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z"
    }
  ]
}

GET /v1/apps/:id

Get application details by ID.

Requires: Authentication

POST /v1/apps

Create a new application.

Requires: Authentication

{
  "name": "My App",
  "slug": "my-app",
  "description": "App description"
}

PUT /v1/apps/:id

Update an application.

Requires: Authentication

POST /v1/licenses/verify

Verify a license key (public endpoint, no authentication required).

{
  "key": "LC-XXXXXX-XXXXXX-XXXXXX"
}

{
  "valid": true,
  "status": "ACTIVE",
  "expiresAt": "2025-12-31T23:59:59Z",
  "email": "user@example.com",
  "verificationType": "enterprise",
  "metadata": {
    "ipAddress": "192.168.1.1",
    "userAgent": "Mozilla/5.0...",
    "verifiedAt": "2024-01-01T00:00:00.000Z",
    "advancedChecks": true
  }
}

{
  "valid": false,
  "reason": "License key not found",
  "status": "EXPIRED|REVOKED|SUSPENDED"
}

GET /v1/apps/:appId/licenses

List all licenses for an application.

Requires: Authentication

{
  "licenses": [
    {
      "id": "license_id",
      "appId": "app_id",
      "key": "LC-XXXXXX-XXXXXX-XXXXXX",
      "plan": "PRO",
      "status": "ACTIVE",
      "issuedTo": "John Doe",
      "issuedEmail": "user@example.com",
      "expiresAt": "2025-12-31T23:59:59Z",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z"
    }
  ],
  "total": 1
}

POST /v1/apps/:appId/licenses

Create a new license.

Requires: Authentication

{
  "appId": "app_id",
  "plan": "PRO",
  "issuedTo": "John Doe",
  "issuedEmail": "user@example.com",
  "expiresAt": "2025-12-31T23:59:59Z"
}

GET /v1/licenses/:id

Get license details by ID or license key.

Requires: Authentication

{
  "id": "license_id",
  "appId": "app_id",
  "key": "LC-XXXXXX-XXXXXX-XXXXXX",
  "licenseKey": "LC-XXXXXX-XXXXXX-XXXXXX",
  "plan": "PRO",
  "status": "ACTIVE",
  "issuedTo": "John Doe",
  "issuedEmail": "user@example.com",
  "email": "user@example.com",
  "expiresAt": "2025-12-31T23:59:59Z",
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z"
}

PATCH /v1/licenses/:id

Update a license.

Requires: Authentication

{
  "expiresAt": "2025-12-31T23:59:59Z",
  "status": "ACTIVE"
}

PATCH /v1/licenses/:id/status

Update license status.

Requires: Authentication

{
  "status": "ACTIVE|INACTIVE|SUSPENDED|REVOKED|EXPIRED"
}

POST /v1/webhooks

Create a webhook.

Requires: Authentication

GET /v1/webhooks

List all webhooks.

Requires: Authentication

GET /v1/webhooks/:id

Get webhook details.

Requires: Authentication

PUT /v1/webhooks/:id

Update a webhook.

Requires: Authentication

DELETE /v1/webhooks/:id

Delete a webhook.

Requires: Authentication

GET /v1/analytics/stats

Get overall statistics (Admin only).

Requires: Authentication, Admin role

GET /v1/analytics/revenue

Get revenue analytics.

Requires: Authentication

GET /v1/analytics/licenses

Get license analytics.

Requires: Authentication