API Reference

Die API Reference enthält die verfügbaren Endpunkte, Parameter und Antwortbeispiele für die VPC-Systeme. Die produktive VPC API ist unter https://api.ucp.li erreichbar und benötigt einen API-Key. Die Pfade in den Tabellen werden direkt an diese Basis-URL angehängt. Verwende kein zusätzliches /api.

Verfügbare APIs

• VPC API
• CopNet API
• MedicNet API
• CarNet API
• FireNet API

Kurzüberblick zur VPC API

Die interaktive VPC API Reference enthält die vollständigen Details, Response-Beispiele und Schemas.

Fahrzeuge

Methode	Pfad	Beschreibung
GET	/vehicles	Fahrzeuge des API-Key-Netzwerks paginiert listen
POST	/vehicles	Fahrzeug im API-Key-Netzwerk erstellen
GET	/vehicles/{vehicle}	Einzelnes Fahrzeug anzeigen
PUT	/vehicles/{vehicle}	Fahrzeugdaten aktualisieren
PATCH	/vehicles/{vehicle}	Einzelne Fahrzeugfelder aktualisieren
DELETE	/vehicles/{vehicle}	Fahrzeug löschen

Statistiken

Methode	Pfad	Beschreibung
GET	/statistics/active-users	Aktuell eingestempelte Officer mit Beginn ihrer Dienstzeit auflisten
GET	/statistics/missions/last-7-days	Einsatzberichte der letzten sieben Tage zählen
GET	/statistics/missions/total	Alle Einsatzberichte zählen
GET	/statistics/files/last-7-days	Patienten- und Täterakten der letzten sieben Tage zählen
GET	/statistics/files/total	Alle Patienten- und Täterakten zählen

Für alle Statistik-Endpunkte gilt:

• Die Werte beziehen sich ausschließlich auf das Netzwerk des verwendeten API-Keys.
• Die beiden 7-Tage-Endpunkte zählen Datensätze, deren created_at-Wert mindestens dem Zeitpunkt sieben Tage vor der Anfrage entspricht. Datensätze ohne bekannten Erstellungszeitpunkt bleiben unberücksichtigt, auch wenn timestampAvailable den Wert true hat.
• Kann das System die Erstellungszeiten nicht auswerten, antwortet der jeweilige 7-Tage-Endpunkt mit count: null und timestampAvailable: false. Interpretiere null nicht als 0. Der zugehörige /total-Endpunkt bleibt verfügbar und zählt auch Datensätze ohne bekannten Erstellungszeitpunkt. Wende dich an den Support, wenn du die zeitbezogene Statistik benötigst.

Stempeluhr

Methode	Pfad	Beschreibung
POST	/dutytime/{identifier}/toggle	Stempeluhr eines Officers starten oder offene Stempeluhr-Einträge stoppen
POST	/dutytime/{identifier}/stop	Offene Stempeluhr-Einträge eines Officers stoppen; mehrfaches Aufrufen bleibt erfolgreich

Für die Stempeluhr gilt:

• Es ist keine Body-Payload erforderlich. Optional kann ein leerer JSON-Body ({}) gesendet werden.
• identifier ist der beim Officer hinterlegte FiveM-Identifier inklusive Prefix, z. B. license:0000000000000000000000000000000000000000.
• Der Typ muss zur Connector-Konfiguration passen. Weitere Details findest du unter Identifier verstehen.
• Nutze /dutytime/{identifier}/stop für gezieltes Beenden oder Retry-Logik.
• /dutytime/{identifier}/toggle ist für Clients gedacht, die bewusst zwischen Start und Stop wechseln.

Beispiel:

curl -X POST \
  "https://api.ucp.li/dutytime/license:0000000000000000000000000000000000000000/stop" \
  -H "X-API-Key: test-api-key" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{}'

Die internen /fivem-Routen sind absichtlich nicht in der API-Referenz dokumentiert.

Nutzung

Auf jeder API-Seite kannst du:

• Endpunkte über die linke Navigation auswählen.
• HTTP-Methoden, Pfade und Parameter prüfen.
• Response-Beispiele und Schema-Informationen einsehen.
• Zwischen den Produkt-APIs über die Tabs oberhalb der Referenz wechseln.

Hinweise

Die API-Spezifikationen dienen als Referenz für Integrationen. Für produktive Zugangsdaten, Umgebungen oder Freischaltungen nutze die vereinbarten Support- und Onboarding-Kanäle. Wie du einen API-Key erstellst, steht unter API-Key erstellen.