Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Registering Your License

After purchasing a license from the License Server, you need to activate it in your Kinesis API instance. This guide explains how to register your license and understand how the activation system works.

Overview

License registration connects your Kinesis API instance to your purchased license, enabling features and capabilities based on your plan. The process involves:

  1. Entering your license key in Kinesis API
  2. Automatic validation with the License Server
  3. Feature activation based on your plan
  4. Ongoing validation to maintain access

Prerequisites

Before registering your license:

  • ✅ You must have ROOT user permissions
  • ✅ Your license must be ACTIVE in the License Server
  • ✅ You have your license key from the License Server
  • ✅ Your Kinesis API instance can connect to the internet

Accessing License Management

Via Web Interface

  1. Log in to your Kinesis API instance with a ROOT account
  2. Navigate to /web/license in your browser, or
  3. Click “License” in the sidebar menu (visible only to ROOT users)

License Management Page

License Page Components

The license management page displays:

  • License Key Input: Field for entering your license key
  • Show/Hide Key Button: Toggle visibility of your license key
  • Submit Button: Activate your license
  • Validation Button: Manually validate current license
  • Deactivation Button: Remove current license activation
  • License Details: Information about your active license (after activation)

Activating Your License

Step 1: Enter Your License Key

  1. Locate the license key input field on the license page
  2. Click the eye icon to show the input field (if hidden)
  3. Paste your license key from the License Server
    • Format: XXXXXX-XXXXXX-XXXXXX-XXXXXX
    • Ensure no extra spaces or characters

Step 2: Submit for Activation

  1. Click the submit button (save icon) next to the input field
  2. The system will display a loading indicator
  3. Wait for the activation process to complete

Step 3: Activation Process

When you submit your license key, Kinesis API:

  1. Validates Format: Checks if the key is properly formatted
  2. Contacts License Server: Sends activation request with:
    • Your license key
    • Instance ID (unique identifier for your installation)
    • Current user count
  3. Receives Response: License Server returns:
    • Activation confirmation
    • Plan details
    • Feature list
    • Authentication token
  4. Stores Locally: Saves activation information securely
  5. Enables Features: Unlocks capabilities based on your plan

Step 4: Verify Activation

After successful activation:

  1. Success Message: Green notification appears confirming activation
  2. License Details Appear: Panel shows:
    • Plan name and type
    • License status
    • Instance and user limits
    • Billing information
    • Next renewal date
  3. Feature Buttons: Validation and deactivation buttons become visible
  4. License Status Indicator: Bottom-right corner shows “Activated: [Plan Name]”

Manual License Management

Validating Your License

To manually validate your license:

  1. Click the “Validate License” button
  2. System performs immediate validation with License Server
  3. Updates displayed license information
  4. Shows success or error message

Use Cases:

  • After purchasing an upgrade
  • If features seem unavailable
  • After plan changes
  • Troubleshooting license issues

Deactivating Your License

To remove your license activation:

  1. Click the “Deactivate License” button
  2. Confirm deactivation in the warning dialog
  3. System:
    • Notifies License Server
    • Removes local activation
    • Resets to Community features
    • Clears license displays

Warnng: Deactivating your license immediately restricts access to paid features. Your data remains intact, but capabilities are limited to the Community tier.

Troubleshooting

Common Activation Issues

“License has already been activated”

Cause: This license key is already in use

Solution:

  1. Check if you’re trying to activate the same license on multiple instances
  2. Deactivate the license from the other instance first
  3. Or purchase an additional license for more instances

“License key not found”

Cause: Invalid or mistyped license key

Solution:

  1. Copy the license key directly from License Server
  2. Check for extra spaces or characters
  3. Verify the license status is ACTIVE in License Server

“License is not active”

Cause: License needs administrator activation or payment issue

Solution:

  1. Check License Server for license status
  2. Verify payment was processed
  3. Wait for administrator activation (up to 24 hours)
  4. Contact support if delayed

“Failed to connect to License Server”

Cause: Network connectivity issue

Solution:

  1. Verify your instance has internet access
  2. Check firewall settings allow outbound HTTPS
  3. Confirm License Server is accessible (https://license.kinesis.world)
  4. Check proxy settings if applicable

Validation Issues

“Activation token has expired”

Cause: Authentication token needs refresh

Solution:

  1. Click “Validate License” to get new token
  2. System automatically reauthenticates
  3. If that fails, try deactivating and reactivating

“License has expired”

Cause: Subscription period has ended

Solution:

  1. Renew license in License Server
  2. Wait for renewal processing
  3. Click “Validate License” in Kinesis API
  4. Features should restore after successful renewal

“User count exceeded”

Cause: More users than your plan allows

Solution:

  1. Upgrade plan to increase user limit
  2. Or remove inactive users
  3. Contact support for temporary increase

License Status Indicators

Monitor your license status through the indicator in the bottom-right corner:

  • Green “Activated: [Plan]”: License is active and validated
  • Red “License Inactive”: No active license or validation failed

Best Practices

Security

  1. Protect License Keys: Never share publicly or commit to version control
  2. ROOT Access Only: Only ROOT users can manage licenses
  3. Monitor Status: Regularly check license status indicator
  4. Update Promptly: Renew before expiration to avoid interruption

Reliability

  1. Stable Internet: Ensure consistent connectivity for validation
  2. Monitor Check-Ins: Watch for validation errors in logs
  3. Plan Ahead: Renew licenses before expiration
  4. Test Upgrades: Verify feature access after plan changes

Compliance

  1. Stay Within Limits: Monitor user and instance counts
  2. Timely Renewal: Pay invoices promptly
  3. Accurate Information: Keep License Server profile updated
  4. Proper Usage: Follow terms of service for your plan

Next Steps

After successfully activating your license:

  1. Explore features available in your plan
  2. Review the usage documentation
  3. Configure your instance for production use
  4. Start building your APIs

For issues with license activation or validation, please contact support.