API Referenz

Die Z-UCP API ist eine RESTful API, die JSON für die Kommunikation nutzt. Sie wird verwendet, um Daten zwischen dem Panel, der Bridge und externen Tools auszutauschen.

Authentifizierung

Alle Requests an die API müssen einen gültigen API-Key im Header mitsenden:

X-API-Key: DEIN_PROJEKT_KEY

Endpunkte

1. Spieler-Daten (/api/v2/players)

GET /api/v2/players

Gibt eine Liste aller Spieler zurück.

• Query Parameter:
  • limit: (Optional) Anzahl der Ergebnisse (Default: 50)
  • offset: (Optional) Pagination-Offset
  • search: (Optional) Suche nach Name oder Identifier

GET /api/v2/players/:identifier

Gibt detaillierte Informationen zu einem spezifischen Spieler zurück (Inventar, Fahrzeuge, Kontostände).

2. Live Aktionen (/api/v2/bridge)

Diese Endpunkte senden Befehle direkt an den FiveM-Server.

POST /api/v2/bridge/:serverId/kick

Kickt einen Spieler vom Server.

• Body:

  {
    "target": "identifier",
    "reason": "Regelverstoss"
  }
  

POST /api/v2/bridge/:serverId/money

Gibt einem Spieler Geld oder zieht es ab.

• Body:

  {
    "target": "identifier",
    "type": "bank",
    "amount": 5000,
    "action": "add"
  }
  

3. System Status (/api/v2/health)

Gibt den Status der API und der Datenbank-Verbindungen zurück.

Rate Limiting

Die API ist auf 100 Requests pro Minute pro Projekt limitiert. Bei Überschreitung wird ein 429 Too Many Requests Fehler zurückgegeben.