Home Guides
Referenz · Entwickler

API-Referenz

Die yarn-API läuft zentral auf api.yarn.netica.dev. Jeder Tenant authentifiziert sich mit seinem eigenen API-Key aus dem Portal.

Authentifizierung

API-Key im Authorization-Header als Bearer-Token mitsenden:

Authorization: Bearer tk_live_...
Authorization: Bearer Für alle FiveM-Server-zu-API-Requests (yarn_sync).
?key=tk_live_... Alternativer Query-Parameter für Webhook-Endpunkte.
Session-Cookie Für Browser-Anfragen nach Login im Portal.
API-Keys findest und verwaltest du unter Portal → FiveM & API. Keys können jederzeit widerrufen und neu erstellt werden.
Base URL
https://api.yarn.netica.dev

Endpunkte

POST /sync/players

Spielerdaten (Charakter, Fraktion, Position, Status) synchronisieren. Wird von yarn_sync automatisch aufgerufen.

Auth: API-Key

GET /sync/whitelist/{steam_hex}

Whitelist-Status eines Spielers anhand der Steam-Hex-ID abfragen. Gibt pending, whitelisted oder banned zurück.

Auth: API-Key

POST /sync/players/{steam_hex}/status

Spieler-Status direkt setzen (z. B. nach Ban durch Serveradmin).

Auth: API-Key

POST /webhooks/{tenant_slug}

Discord-kompatibler Webhook-Endpunkt. Nimmt Embeds entgegen und speichert sie als Smart Logs.

Auth: API-Key (Query-Param)

POST /bodycam/upload

Bodycam-Video-Chunk hochladen (multipart/form-data). Wird von yarn_sync aufgerufen.

Auth: API-Key

GET /bodycam/{id}

Bodycam-Video abrufen. Nur für Teammitglieder des Tenants zugänglich.

Auth: Session (Browser)

PocketBase REST API — Alle direkten Datenbankoperationen laufen über die PocketBase REST API. Vollständige Dokumentation: pocketbase.io/docs