Documentation — Kyraxx

1

Create an Account

Sign up at kyraxx.dev/register with your email address. Verify your email to activate the dashboard.

2

Create an Application

From the dashboard, click New Application. Give it a name and optional description. Each application has its own users, licenses, and configuration.

3

Generate an API Key

In your app settings, generate an API key. This key is used to authenticate all API requests.

X-API-Key: krxx_live_your_api_key_here

Store this key securely. It will only be shown once.

4

Install the SDK

Choose the SDK for your language and install it using your package manager.

# Python
pip install kyraxx

# JavaScript / TypeScript
npm install @kyraxx/sdk

# Go
go get github.com/kyraxx/kyraxx-go

# Rust
cargo add kyraxx

5

Initialize the Client

Create a client instance with your app ID and API key.

import kyraxx

client = kyraxx.Client(
    app_id="your-app-id",
    api_key="krxx_live_..."
)

# Initialize the session
client.init()

6

Implement Authentication

Use the login and register methods to authenticate users, then validate licenses as needed.

# Login
session = client.login(
    username="user@example.com",
    password="secure_pass",
    hwid=kyraxx.get_hwid()
)

# Validate license
license = client.validate_license(
    key="KRXX-A1B2-C3D4-E5F6"
)

if license.is_valid:
    print(f"Licensed until {license.expires}")

★

Prefer a ready-made project? Start from an example

If you'd rather not wire things up by hand, grab one of the five ready-to-run example projects. Each one is fully self-contained (the SDK is already bundled), and you configure it by editing a single file — paste your 4 credentials and run. The hardware ID (HWID) is generated for you automatically, so HWID locking works out of the box.

Language	Edit this file	Run
Python	kyraxx_config.json	python main.py
C#	kyraxx_config.json	dotnet run
C++	config.hpp	cmake -B build && cmake --build build
Java	kyraxx_config.json	mvn -q compile exec:java
JS / TS	kyraxx_config.json	npm install && npm start

Find them in sdks/examples/. Each project walks through init → login → session check → reading a server-side variable, with clear [ok] / [error] output and handling for the common cases (wrong version, HWID mismatch, bad credentials, rate limiting).