Documentation gerade gezogen

Dieser Commit ist enthalten in:
2025-06-22 20:17:05 +02:00
Ursprung 4b093fa3a9
Commit 8cb483a034
3 geänderte Dateien mit 131 neuen und 117 gelöschten Zeilen

Datei anzeigen

@@ -12,10 +12,12 @@ X-API-Key: AF-2025-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
```
**API Key Management:**
- API keys can be managed through the Admin Panel under Administration → API Keys
- API keys can be managed through the Admin Panel under "Lizenzserver Administration""System-API-Key generieren"
- Keys follow the format: `AF-YYYY-[32 random characters]`
- Only one system API key is active at a time
- Regenerating the key will immediately invalidate the old key
- The initial API key is automatically generated on first startup
- To retrieve the initial API key from database: `SELECT api_key FROM system_api_key WHERE id = 1;`
**Error Response (401 Unauthorized):**
```json
@@ -28,6 +30,8 @@ X-API-Key: AF-2025-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
## License Server API
**Base URL:** `https://api-software-undso.z5m7q9dk3ah2v1plx6ju.com`
### Public Endpoints
#### GET /
@@ -136,7 +140,7 @@ Get license information.
**Headers:**
```
X-API-Key: your-api-key
X-API-Key: AF-2025-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
```
**Response:**
@@ -168,6 +172,8 @@ X-API-Key: your-api-key
### Session Management API Endpoints
**Note:** Session endpoints require that the client application is configured in the `client_configs` table. The default client "Account Forger" is pre-configured.
#### POST /api/license/session/start
Start a new session for a license.
@@ -235,7 +241,7 @@ Check for available updates.
**Headers:**
```
X-API-Key: your-api-key
X-API-Key: AF-2025-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
```
**Request:**
@@ -246,20 +252,38 @@ X-API-Key: your-api-key
}
```
**Response:** Update availability status with version info
**Response:**
```json
{
"update_available": true,
"latest_version": "1.1.0",
"download_url": "https://example.com/download/v1.1.0",
"release_notes": "Bug fixes and performance improvements"
}
```
#### GET /api/version/latest
Get latest version information.
**Headers:**
```
X-API-Key: your-api-key
X-API-Key: AF-2025-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
```
**Response:** Latest version information
**Response:**
```json
{
"version": "1.1.0",
"release_date": "2025-06-20",
"download_url": "https://example.com/download/v1.1.0",
"release_notes": "Bug fixes and performance improvements"
}
```
## Admin Panel API
**Base URL:** `https://admin-panel-undso.z5m7q9dk3ah2v1plx6ju.com`
### Customer API Endpoints
#### GET /api/customers
@@ -791,7 +815,7 @@ All errors return JSON with `error`, `code`, and `status` fields.
Example request with required headers:
```bash
curl -X POST http://localhost/api/license/activate \
curl -X POST https://api-software-undso.z5m7q9dk3ah2v1plx6ju.com/api/license/activate \
-H "X-API-Key: AF-2025-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" \
-H "Content-Type: application/json" \
-d '{
@@ -810,7 +834,13 @@ curl -X POST http://localhost/api/license/activate \
- Username: `w@rh@mm3r` / Password: `Warhammer123!`
- API Key: Generated in Admin Panel under "Lizenzserver Administration"
### Getting the Initial API Key
If you need to retrieve the API key directly from the database:
```bash
docker exec -it v2_postgres psql -U postgres -d v2_db -c "SELECT api_key FROM system_api_key WHERE id = 1;"
```
### Test Endpoints
- Admin Panel: `http://localhost:80`
- License Server API: `http://localhost:80/api`
- Admin Panel: `https://admin-panel-undso.z5m7q9dk3ah2v1plx6ju.com/`
- License Server API: `https://api-software-undso.z5m7q9dk3ah2v1plx6ju.com/`
- Monitoring: See OPERATIONS_GUIDE.md