API reference

Authentication endpoints

API endpoints for app user authentication and token management.

Base URL

https://vaultix.cc/api

All endpoints require your app API key in the request body or headers.

Log in with a key

POST/app_auth/login_key

Authenticate an app user with a key (key mode).

Request bodyJSONCopy

{
  "api_key": "ap_your_api_key",
  "key": "MYAPP-1234-5678-ABCD-EFGH",
  "hwid": "optional_hardware_id"
}

Response · 200JSONCopy

{
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_at": "2025-11-02T12:05:00Z",
  "user": {
    "id": "user_xxxxxxxxxxxxx",
    "key": "MYAPP-1234-5678-ABCD-EFGH",
    "app_id": "app_xxxxxxxxxxxxx"
  },
  "subscriptions": ["prod_xxxxxxxxxxxxx"]
}

The returned JWT is valid for 5 minutes and should be included in subsequent requests.

Log in with username and password

POST/app_auth/login

Authenticate an app user with username and password (username mode).

Request bodyJSONCopy

{
  "api_key": "ap_your_api_key",
  "username": "john_doe",
  "password": "user_password",
  "hwid": "optional_hardware_id"
}

Response · 200JSONCopy

{
  "token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
  "expires_at": "2025-11-02T12:05:00Z",
  "user": {
    "id": "user_xxxxxxxxxxxxx",
    "username": "john_doe",
    "email": "john@example.com",
    "app_id": "app_xxxxxxxxxxxxx"
  },
  "subscriptions": ["prod_xxxxxxxxxxxxx"]
}

Error responses

Status	Body	Meaning
401 Unauthorized	`{"detail": "Invalid credentials"}`	Incorrect key, username, or password.
403 Forbidden	`{"detail": "HWID mismatch"}`	User is bound to a different hardware ID.
400 Bad request	`{"detail": "No active subscriptions"}`	User has no active subscriptions to any products.

Using JWT tokens

Include the JWT in subsequent API requests:

Authorization headerHTTPCopy

Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

Tokens expire after 5 minutes. Re-authenticate or implement token refresh logic in your client.

Token payload

The JWT contains:

app_id: Application ID
app_user_id: User ID
subscriptions: Array of product IDs the user can access
exp: Token expiration timestamp
jti: Unique token ID (used for session tracking)

Vaultix · Features · Pricing · Documentation · Changelog · llms.txt