API Docs

API Documentation

Integrate UltimateAuth into your applications with our powerful and easy-to-use REST API. Authenticate users, manage licenses, and track analytics with simple HTTP requests.

v1.0.0 Stable

HTTPS Only

Authentication

Manage user authentication, registration, and session tokens.

POST/api/auth/register

Request Body

json

1{
2  "email": "user@example.com",
3  "password": "securePassword123",
4  "username": "newuser"
5}

Response

json

1{
2  "success": true,
3  "message": "User registered successfully",
4  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
5}

POST/api/auth/login

Authenticate a user and receive a session token.

Request Body

json

1{
2  "email": "user@example.com",
3  "password": "securePassword123"
4}

Response

json

1{
2  "success": true,
3  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
4  "user": {
5    "id": "user_123",
6    "email": "user@example.com",
7    "subscription": "developer",
8    "hwid": "A1B2-C3D4-E5F6-G7H8",
9    "ip": "192.168.1.100"
10  }
11}

Applications

Create and manage your applications.

GET/api/applications

List all applications owned by the authenticated user.

Response

json

1{
2  "success": true,
3  "applications": [
4    {
5      "id": "app_1",
6      "name": "My Awesome App",
7      "status": "active",
8      "version": "1.0.0",
9      "users": 150
10    }
11  ]
12}

POST/api/applications

Create a new application.

Request Body

json

1{
2  "name": "New App",
3  "version": "1.0.0",
4  "description": "A new project"
5}

Response

json

1{
2  "success": true,
3  "application": {
4    "id": "app_2",
5    "name": "New App",
6    "secret": "sk_live_abc123def456",
7    "status": "active",
8    "createdAt": "2023-11-22T10:00:00Z"
9  }
10}

Licenses

Generate and validate licenses for your applications.

POST/api/licenses/validate

Validate a license key.

Request Body

json

1{
2  "license": "KEY-1234-5678-90AB",
3  "hwid": "hwid_signature_here"
4}

Response

json

1{
2  "success": true,
3  "valid": true,
4  "expiry": "2025-12-31T23:59:59Z"
5}

POST/api/licenses/activate

Activate a license key for a specific HWID.

Request Body

json

1{
2  "license": "KEY-1234-5678-90AB",
3  "hwid": "hwid_signature_here"
4}

Response

json

1{
2  "success": true,
3  "message": "License activated successfully"
4}

App Users

Manage end-users for your applications.

GET/api/users?appId=app_1

Get a list of users for a specific application.

Response

json

1{
2  "success": true,
3  "users": [
4    {
5      "id": "u_1",
6      "username": "gamer123",
7      "status": "active"
8    },
9    {
10      "id": "u_2",
11      "username": "playerOne",
12      "status": "banned"
13    }
14  ]
15}

File Management

Securely manage and serve files.

GET/api/files/download/:fileId

Get a secure download URL for a file.

Response

json

1{
2  "success": true,
3  "url": "https://cdn.ultimateauth.com/secure/..."
4}

Variables

Manage global and user-specific variables.

GET/api/variables/:key

Retrieve a global variable by key.

Response

json

1{
2  "success": true,
3  "value": "config_value_123"
4}

Analytics

Track application usage and events.

POST/api/analytics/event

Log a custom event.

Request Body

json

1{
2  "event": "button_click",
3  "data": {
4    "buttonId": "start_game"
5  }
6}

Response

json

1{
2  "success": true
3}