JKz-API v1
Öffentliche Endpoints & Integration

Inhaltsverzeichnis

1. Grundlagen
2. Authentifizierung
3. Code-Beispiele
4. Öffentliche Endpoints (117)

1. Grundlagen

Diese Dokumentation enthält alle für Nutzer und Entwickler bestimmten Routen der JKz-API v1. Reine Admin-, Moderations-, interne Service- und Webhook-Routen sind bewusst ausgeschlossen.

Basis-URL

https://api.jkz-group.de

Alle Pfade beginnen mit /v1/. Für Clients ohne Redirect-Following ist der abschließende Slash kanonisch (z. B. /v1/health/); das Terminal ergänzt ihn automatisch. Fehler folgen dem Schema {"error":{"code":"…","message":"…"}}.

Bearer-Token

Authorization: Bearer <access_token>

Keycloak-Login nutzt die normale JKz-Sitzung. Game-Token bedeutet: Der Token muss über den registrierten OAuth-Client des Spiels ausgestellt worden sein.

Sicher testen

POST, PUT und DELETE im Web-Terminal gehen an die produktive API und können Daten, Käufe oder E-Mails auslösen. Prüfe die editierbare Anfrage vor dem Absenden. Binärantworten werden auf eine Vorschau begrenzt.

2. Authentifizierung

Keycloak-Sitzung für das Web-Terminal

Das Access-Token bleibt im Session-Speicher dieses Browser-Tabs und wird weder in die Seite noch in Logs geschrieben. Game-SDK-Routen benötigen den Token des jeweiligen Spiel-Clients; dieser kann im Terminal überschrieben werden.

Nicht angemeldet

3. Code-Beispiele

Die Beispiele verwenden denselben Bearer-Header wie das Web-Terminal.

const response = await fetch("https://api.jkz-group.de/v1/users/profile/me/", {
  headers: {
    "Accept": "application/json",
    "Authorization": `Bearer ${accessToken}`
  }
});
const data = await response.json();

$curl = curl_init('https://api.jkz-group.de/v1/users/profile/me/');
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 10,
    CURLOPT_HTTPHEADER => [
        'Accept: application/json',
        'Authorization: Bearer ' . $accessToken,
    ],
]);
$response = curl_exec($curl);

using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", accessToken);
using var response = await client.GetAsync(
    "https://api.jkz-group.de/v1/users/profile/me/");
var json = await response.Content.ReadAsStringAsync();

4. Öffentliche Endpoints

„Im Web-Terminal öffnen“ blendet direkt unter der Route eine vollständig editierbare Anfrage und die Live-Antwort ein.

4.1 System & Allgemein

3 Routen

GET /v1/health

Ohne Login

Aggregierter Status der JKz-Dienste und ihrer Abhängigkeiten.

Parameter: Optional: status.
Antwort: {"status":"operational","services":[],"checkedAt":"…"}

JKz API Web-Terminal · /v1/health

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/beta/validate

Ohne Login

Prüft einen GameStore-Beta-Key und liefert bei Erfolg dessen Metadaten.

Parameter: JSON: key (Pflicht).
Antwort: {"valid":true,"data":{}}

JKz API Web-Terminal · /v1/beta/validate

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/contact

Ohne Login

Versendet eine Kontakt- oder Bewerbungsnachricht; optional mit PDF-/ZIP-Anhang bis 8 MiB.

Parameter: JSON/Form: name, email, subject, bodyText. Bei Multipart beliebige Datei-Feldnamen.
Antwort: {"success":true,"message":"Nachricht wurde erfolgreich versendet."}

JKz API Web-Terminal · /v1/contact

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Datei für attachment

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

4.2 Badges

2 Routen

GET /v1/badges/list

Ohne Login

Listet alle verfügbaren Badges einschließlich Farben, Logos und Nutzeranzahl.

Parameter: Keine.
Antwort: {"data":[],"count":0}

JKz API Web-Terminal · /v1/badges/list

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/badges/user

Ohne Login

Listet die Badges eines Nutzers.

Parameter: Query: id (Keycloak-UUID, Pflicht).
Antwort: {"userId":"…","count":0,"badges":[]}

JKz API Web-Terminal · /v1/badges/user

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

4.3 Chat

4 Routen

GET POST /v1/chat/conversations

Keycloak-Login

Listet eigene Direkt-Konversationen oder erstellt/findet eine 1:1-Konversation.

Parameter: POST JSON: toUserId (Pflicht).
Antwort: {"data":[]}

JKz API Web-Terminal · /v1/chat/conversations

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST /v1/chat/messages

Keycloak-Login

Liest Nachrichten einer eigenen Konversation oder sendet E2EE-Nachrichten.

Parameter: GET Query: conversationId, limit (max. 100). POST: conversationId, toUserId, ciphertext, nonce, optional protocolHeader.
Antwort: {"data":[]}

JKz API Web-Terminal · /v1/chat/messages

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/chat/keys/me

Keycloak-Login

Speichert oder aktualisiert den öffentlichen Chat-Identity-Key des angemeldeten Nutzers.

Parameter: JSON: publicKeyJwk, algorithm.
Antwort: {"data":{"userId":"…","algorithm":"…"}}

JKz API Web-Terminal · /v1/chat/keys/me

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/chat/keys/user

Keycloak-Login

Liefert den öffentlichen Chat-Identity-Key eines Nutzers.

Parameter: Query: id (User-UUID, Pflicht).
Antwort: {"data":{"userId":"…","publicKeyJwk":{},"algorithm":"…"}}

JKz API Web-Terminal · /v1/chat/keys/user

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

4.4 Nutzer & Profile

11 Routen

GET /v1/users

Ohne Login

Listet die Usernamen des öffentlichen JKz-Realms.

Parameter: Keine.
Antwort: {"count":0,"usernames":[]}

JKz API Web-Terminal · /v1/users

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/users/profile/username

Ohne Login

Liefert die freigegebenen Felder eines öffentlichen Profils per Username oder UUID.

Parameter: Query: genau eines von username oder id; optional fields als kommaseparierte Allowlist.
Antwort: {"data":{"id":"…","username":"Alice"}}

JKz API Web-Terminal · /v1/users/profile/username

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET PUT /v1/users/profile/me

Keycloak-Login

Liest oder aktualisiert das eigene Profil und ausgewählte Keycloak-Basisfelder.

Parameter: GET optional fields. PUT: displayName, bio, birthdate, Hintergrund-/Sichtbarkeits-/Newsletterfelder sowie optional username und email.
Antwort: {"data":{"id":"…","displayName":"Alice"}}

JKz API Web-Terminal · /v1/users/profile/me

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/users/profile/me/avatar

Keycloak-Login

Lädt das eigene Avatarbild hoch und aktualisiert die Profil-URL.

Parameter: Multipart: file (Bild, Pflicht; Serverlimit 5 MiB).
Antwort: {"data":{"avatarUrl":"https://…"}}

JKz API Web-Terminal · /v1/users/profile/me/avatar

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf Datei für file

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/users/profile/me/banner

Keycloak-Login

Lädt das eigene Profilbanner hoch und aktualisiert die Profil-URL.

Parameter: Multipart: file (Bild, Pflicht; Serverlimit 5 MiB).
Antwort: {"data":{"bannerUrl":"https://…"}}

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf Datei für file

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/users/profile/me/password

Keycloak-Login

Reservierter Passwort-Endpunkt. Er antwortet derzeit immer mit 501; Passwortänderungen erfolgen über Keycloak.

Parameter: Keine nutzbare Payload.
Antwort: {"error":{"code":"PASSWORD_CHANGE_NOT_IMPLEMENTED","message":"…"}}

JKz API Web-Terminal · /v1/users/profile/me/password

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/users/sanctions/username

Ohne Login

Liefert die öffentlich sichtbaren Sanktionen eines Nutzers.

Parameter: Query: id oder username; optional only_active=1|0 (Standard 1).
Antwort: {"id":"…","username":"Alice","only_active":true,"count":0,"sanctions":[]}

JKz API Web-Terminal · /v1/users/sanctions/username

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET PUT /v1/users/theme/me

Keycloak-Login

Liest oder speichert das persönliche Portal-/Store-Theme.

Parameter: PUT JSON: mode, accent, accentHover, bgPage, bgPanel, previewBg.
Antwort: {"data":{"theme":{}}}

JKz API Web-Terminal · /v1/users/theme/me

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/users/integrations/discord/me

Keycloak-Login

Liefert den Status der eigenen Discord-Verknüpfung.

Parameter: Keine.
Antwort: {"data":{"connected":false}}

JKz API Web-Terminal · /v1/users/integrations/discord/me

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/users/integrations/discord/unlink

Keycloak-Login

Trennt die eigene Discord-Verknüpfung.

Parameter: Keine.
Antwort: {"success":true}

JKz API Web-Terminal · /v1/users/integrations/discord/unlink

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST /v1/integrations/discord/confirm

Ohne Login

Bestätigt eine Discord-Verknüpfung über einen einmaligen Token.

Parameter: GET Query oder POST JSON: token (20–300 Zeichen).
Antwort: {"success":true,"status":"CONNECTED"}

JKz API Web-Terminal · /v1/integrations/discord/confirm

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

4.5 Beziehungen & Datenschutz

10 Routen

GET POST DELETE /v1/users/blocks

Keycloak-Login

Listet eigene Blockierungen, blockiert Nutzer oder entfernt eine Blockierung.

Parameter: POST JSON: blockedUserId. DELETE Query: id (Block-ID).
Antwort: {"data":[]}

JKz API Web-Terminal · /v1/users/blocks

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/users/blocks/unblock

Keycloak-Login

Hebt eine eigene Blockierung anhand ihrer Block-ID auf.

Parameter: JSON: id.
Antwort: {"success":true}

JKz API Web-Terminal · /v1/users/blocks/unblock

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST /v1/users/friend-requests

Keycloak-Login

Listet Freundschaftsanfragen oder sendet eine neue Anfrage.

Parameter: GET Query: direction=inbound|outbound|all, status. POST: toUserId, optional message.
Antwort: {"data":[]}

JKz API Web-Terminal · /v1/users/friend-requests

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/users/friend-requests/accept

Keycloak-Login

Akzeptiert eine eingegangene Freundschaftsanfrage.

Parameter: JSON: id (Request-ID).
Antwort: {"success":true}

JKz API Web-Terminal · /v1/users/friend-requests/accept

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/users/friend-requests/cancel

Keycloak-Login

Bricht eine selbst gesendete Freundschaftsanfrage ab.

Parameter: JSON: id (Request-ID).
Antwort: {"success":true}

JKz API Web-Terminal · /v1/users/friend-requests/cancel

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/users/friend-requests/decline

Keycloak-Login

Lehnt eine eingegangene Freundschaftsanfrage ab.

Parameter: JSON: id (Request-ID).
Antwort: {"success":true}

JKz API Web-Terminal · /v1/users/friend-requests/decline

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/users/friend-requests/unfriend

Keycloak-Login

Entfernt eine bestehende Freundschaft.

Parameter: JSON: id (Freund-User-ID).
Antwort: {"success":true}

JKz API Web-Terminal · /v1/users/friend-requests/unfriend

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET PUT POST /v1/users/privacy/consent

Keycloak-Login

Liest oder ändert die Einwilligung für personalisierte Empfehlungen.

Parameter: GET optional includeHistory=1. PUT/POST: personalizedRecommendations oder status; optional source.
Antwort: {"data":{"consent":{}}}

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/users/privacy/events

Keycloak-Login

Übermittelt eine begrenzte Liste von Empfehlungs-/Interaktionsereignissen.

Parameter: JSON: events (Array).
Antwort: {"accepted":0}

JKz API Web-Terminal · /v1/users/privacy/events

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/users/privacy/fyp

Keycloak-Login

Liefert personalisierte Spielempfehlungen unter Berücksichtigung der Einwilligung.

Parameter: Query: limit (max. serverseitig begrenzt), exclude (kommaseparierte UUIDs).
Antwort: {"data":[]}

JKz API Web-Terminal · /v1/users/privacy/fyp

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

4.6 Nachrichten & Sicherheit

6 Routen

GET /v1/messages

Keycloak-Login

Listet Systemnachrichten des angemeldeten Nutzers.

Parameter: Query: limit (1–100).
Antwort: {"data":[]}

JKz API Web-Terminal · /v1/messages

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST PUT /v1/messages/read

Keycloak-Login

Markiert eine oder alle Systemnachrichten als gelesen.

Parameter: JSON: messageId/id oder all/markAll=true.
Antwort: {"success":true}

JKz API Web-Terminal · /v1/messages/read

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/notifications

Keycloak-Login

Listet Benachrichtigungen des angemeldeten Nutzers.

Parameter: Query: limit.
Antwort: {"data":[]}

JKz API Web-Terminal · /v1/notifications

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST PUT /v1/notifications/read

Keycloak-Login

Markiert eine oder alle Benachrichtigungen als gelesen.

Parameter: JSON: notificationId/id oder all/markAll=true.
Antwort: {"success":true}

JKz API Web-Terminal · /v1/notifications/read

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST /v1/security/e2ee/user-key

Keycloak-Login

Liest oder speichert den aktiven öffentlichen E2EE-Key samt verschlüsseltem privaten Schlüssel.

Parameter: POST: algorithm, usage, publicKeyPem, encryptedPrivateKey.
Antwort: {"data":{"key":{}}}

JKz API Web-Terminal · /v1/security/e2ee/user-key

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/moderation/violations/me

Keycloak-Login

Listet ausschließlich die eigenen Moderationsverstöße; dies ist kein Moderator-Endpunkt.

Parameter: Query: limit, offset, status, includeMatches=1.
Antwort: {"data":[],"count":0}

JKz API Web-Terminal · /v1/moderation/violations/me

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

4.7 Meldungen

7 Routen

GET /v1/reports/categories

Ohne Login

Listet aktive öffentliche Meldekategorien.

Parameter: Keine.
Antwort: {"data":[]}

JKz API Web-Terminal · /v1/reports/categories

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/reports

Erstellt eine Meldung. ACCOUNT/PSEUDONYM benötigen Login; ANONYMOUS ist ohne Login möglich.

Parameter: JSON: categoryCode, contactEmail; außerdem description und/oder reportedObjectType/reportedObjectId. Optional reportedUserId, visibilityMode, wantsSecureChat.
Antwort: {"data":{"reportId":1}}

JKz API Web-Terminal · /v1/reports

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/reports/submit

Aktueller Melde-Endpunkt mit Support-Ticket-/Zammad-Anbindung; anonyme Meldungen sind möglich.

Parameter: JSON wie /v1/reports. reporterUserId ist für interne Übergangssysteme vorgesehen und sollte öffentlich nicht gesetzt werden.
Antwort: {"data":{"reportId":1}}

JKz API Web-Terminal · /v1/reports/submit

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/reports/my

Keycloak-Login

Listet eigene Meldungen.

Parameter: Query: status, page, limit (max. 100).
Antwort: {"data":[],"page":1,"limit":20,"total":0}

JKz API Web-Terminal · /v1/reports/my

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/reports/detail

Keycloak-Login

Liefert Details einer Meldung, wenn der Nutzer Reporter oder Teilnehmer ist.

Parameter: Query: id (numerische Report-ID).
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/reports/detail

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST /v1/reports/messages

Keycloak-Login

Liest oder sendet E2EE-Nachrichten im eigenen Report-Chat.

Parameter: GET: reportId, optional since/limit. POST: reportId, contentType, ciphertext, nonce, authTag, optional attachmentId.
Antwort: {"data":[]}

JKz API Web-Terminal · /v1/reports/messages

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/reports/attachments

Keycloak-Login

Lädt einen Anhang zu einer Meldung hoch, auf die der Nutzer Zugriff hat.

Parameter: Multipart: reportId und file (max. 10 MiB gemäß API-Konfiguration).
Antwort: {"data":{"attachmentId":1}}

JKz API Web-Terminal · /v1/reports/attachments

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf Datei für file

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

4.8 Spielekatalog

11 Routen

GET /v1/games/categories

Ohne Login

Listet öffentliche Spielekategorien samt Zähler.

Parameter: Keine.
Antwort: {"data":[]}

JKz API Web-Terminal · /v1/games/categories

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/games/categories/games

Ohne Login

Listet öffentliche Spiele einer Kategorie.

Parameter: Query: category oder slug.
Antwort: {"data":[]}

JKz API Web-Terminal · /v1/games/categories/games

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/games/featured

Ohne Login

Liefert die aktuell hervorgehobenen öffentlichen Spiele.

Parameter: Keine.
Antwort: {"data":[]}

JKz API Web-Terminal · /v1/games/featured

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/games/community

Ohne Login

Liefert Community-Aktivität und Top-Inhalte.

Parameter: Query: commentLimit, topLimit.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/games/community

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/games/public/info

Ohne Login

Liefert öffentliche Detailinformationen zu einem Spiel.

Parameter: Query: id/gameUuid/uuid.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/games/public/info

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/games/public/by-user

Ohne Login

Listet öffentliche Spiele eines Uploaders.

Parameter: Query: id oder userId.
Antwort: {"data":[]}

JKz API Web-Terminal · /v1/games/public/by-user

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/games/build/web-current

Ohne Login

Liefert den aktuellen akzeptierten Web-Build eines öffentlichen Spiels.

Parameter: Query: id/gameUuid/uuid.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/games/build/web-current

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST PUT /v1/games/ratings

Keycloak-Login

Liest Bewertungsstatistiken und setzt die eigene Bewertung.

Parameter: GET: id oder ids, optional includeMine=1. POST/PUT: gameUuid/id und rating.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/games/ratings

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST PUT DELETE /v1/games/comments

Keycloak-Login

Liest Kommentare; angemeldete Nutzer können kommentieren, abstimmen und eigene Kommentare ändern/löschen.

Parameter: GET: id/ids, userId/authorId, limit, includeMine. POST: gameUuid, body. PUT: commentUuid plus body oder vote. DELETE Query: commentUuid.
Antwort: {"data":[]}

JKz API Web-Terminal · /v1/games/comments

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST PUT /v1/games/favorites

Keycloak-Login

Liest Favoritenstatus und setzt/entfernt ein eigenes Lieblingsspiel.

Parameter: GET: id oder ids, includeMine. POST/PUT: gameUuid/id und favorited/favorite.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/games/favorites

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST PUT /v1/games/watchlist

Keycloak-Login

Liest Watchliststatus und setzt/entfernt ein Spiel auf der eigenen Watchlist.

Parameter: GET: id oder ids, includeMine. POST/PUT: gameUuid/id und listed/watchlisted.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/games/watchlist

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

4.9 Spiele veröffentlichen

13 Routen

GET /v1/games/my

Keycloak-Login

Listet die Spiele des angemeldeten Uploaders.

Parameter: Keine.
Antwort: {"data":[]}

JKz API Web-Terminal · /v1/games/my

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/games/my/info

Keycloak-Login

Liefert den eigenen Info-Datensatz eines Spiels.

Parameter: Query: id (Game-UUID).
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/games/my/info

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/games/my/build

Keycloak-Login

Listet eigene Builds eines Spiels oder liefert einen eigenen Build.

Parameter: Query: genau eines von gameid oder buildid.
Antwort: {"data":[]}

JKz API Web-Terminal · /v1/games/my/build

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/games/info/upload

Keycloak-Login

Reicht neue Spielinformationen mit Icon und Banner ein.

Parameter: Multipart: metadata (JSON), icon und banner. Die Metadaten enthalten u. a. title, description, genre und Plattformdaten.
Antwort: {"data":{"gameUuid":"…"}}

JKz API Web-Terminal · /v1/games/info/upload

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf Datei für icon Datei für banner

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/games/info/edit

Keycloak-Login

Bearbeitet eigene Spielinformationen; Icon/Banner sind optional ersetzbar.

Parameter: Multipart: metadata mit gameId/gameUuid; optional icon und banner.
Antwort: {"data":{"gameUuid":"…"}}

JKz API Web-Terminal · /v1/games/info/edit

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf Datei für icon Datei für banner

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/games/build/upload

Keycloak-Login

Lädt einen komprimierten Build zu einem eigenen Spiel hoch.

Parameter: Multipart: metadata (JSON) und file (Archiv).
Antwort: {"data":{"buildUuid":"…"}}

JKz API Web-Terminal · /v1/games/build/upload

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf Datei für file

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/games/build/current

Keycloak-Login

Setzt einen akzeptierten eigenen Build als aktuelle Version.

Parameter: JSON: buildUuid oder buildId.
Antwort: {"data":{"ok":true,"gameUuid":"…","buildUuid":"…"}}

JKz API Web-Terminal · /v1/games/build/current

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/games/build/delete/request

Keycloak-Login

Fordert die Löschung eines eigenen Builds an und sendet eine Bestätigungs-E-Mail.

Parameter: JSON: buildUuid oder buildId.
Antwort: {"data":{"requestId":"…","expiresAt":"…"}}

JKz API Web-Terminal · /v1/games/build/delete/request

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/games/build/delete/confirm

Ohne Login

Bestätigt eine zuvor angeforderte Build-Löschung per Einmal-Token.

Parameter: Query: token.
Antwort: {"data":{"ok":true}}

JKz API Web-Terminal · /v1/games/build/delete/confirm

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/games/info/delete/request

Keycloak-Login

Fordert die Löschung eines eigenen Spiels an und sendet eine Bestätigungs-E-Mail.

Parameter: JSON: gameUuid oder gameId.
Antwort: {"data":{"requestId":"…","expiresAt":"…"}}

JKz API Web-Terminal · /v1/games/info/delete/request

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/games/info/delete/confirm

Ohne Login

Bestätigt eine zuvor angeforderte Spiel-Löschung per Einmal-Token.

Parameter: Query: token.
Antwort: {"data":{"ok":true}}

JKz API Web-Terminal · /v1/games/info/delete/confirm

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST /v1/games/visibility

Keycloak-Login

Liest oder plant die Sichtbarkeit eines eigenen Spiels.

Parameter: GET/POST: gameUuid/gameId; beim Schreiben visibilityStatus/status, optional scheduledStatus und scheduledAt.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/games/visibility

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST PUT /v1/games/monetization

Keycloak-Login

Liest oder konfiguriert Preis, Währung und Rabatt eines eigenen Spiels.

Parameter: GET: id/gameUuid. POST/PUT: gameUuid, action, isPaid, priceCents/price, currency, optionale Rabattfelder.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/games/monetization

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

4.10 Developer-Portal

22 Routen

GET /v1/dev/me

Keycloak-Login

Aggregiert den eigenen Entwickler-, Onboarding- und Stripe-Status.

Parameter: Optional Query: syncStripe=1.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/dev/me

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/dev/dashboard

Keycloak-Login

Liefert Dashboard-Kennzahlen des Entwicklers.

Parameter: Query: range in Tagen.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/dev/dashboard

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/dev/onboarding/status

Keycloak-Login

Liefert Fortschritt und aktuellen Developer-Tier.

Parameter: Keine.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/dev/onboarding/status

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

PUT /v1/dev/onboarding/profile

Keycloak-Login

Speichert Publisher-Typ, Engine, Teamname und Links für das Onboarding.

Parameter: JSON: publisherType, engine, teamName, links.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/dev/onboarding/profile

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/dev/onboarding/agreements/accept

Keycloak-Login

Dokumentiert die Annahme der erforderlichen Entwicklervereinbarungen.

Parameter: JSON enthält die vom Portal angebotenen Vereinbarungs-/Versionsangaben.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/dev/onboarding/agreements/accept

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/dev/onboarding/compliance/confirm

Keycloak-Login

Bestätigt die Sicherheits- und Compliance-Erklärungen für Uploads.

Parameter: JSON: malwareFreeConfirmed, noUnauthorizedAccessConfirmed.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/dev/onboarding/compliance/confirm

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/dev/onboarding/complete

Keycloak-Login

Schließt ein vollständiges Onboarding ab und aktiviert den Developer-Tier.

Parameter: Keine.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/dev/onboarding/complete

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET PUT /v1/dev/business/profile

Keycloak-Login

Liest oder speichert das geschäftliche Entwickler-/Rechnungsprofil.

Parameter: GET optional syncStripe=1. PUT: die vom Developer-Portal gelieferten Unternehmens-, Steuer- und Adressfelder.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/dev/business/profile

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST /v1/dev/monetization

Keycloak-Login

Liest oder bestätigt die Entwickler-Monetarisierungsvereinbarung.

Parameter: POST: acceptAgreement und optional enablePaidGames.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/dev/monetization

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/dev/stripe-connect

Keycloak-Login

Liefert den eigenen Stripe-Connect-Status.

Parameter: Optional Query: sync=1.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/dev/stripe-connect

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/dev/stripe-connect/link

Keycloak-Login

Erstellt einen Stripe-Connect-Onboarding-Link.

Parameter: Keine.
Antwort: {"data":{"url":"https://…"}}

JKz API Web-Terminal · /v1/dev/stripe-connect/link

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/dev/stripe-connect/refresh

Keycloak-Login

Erstellt einen neuen Link für ein abgelaufenes Stripe-Onboarding.

Parameter: Keine.
Antwort: {"data":{"url":"https://…"}}

JKz API Web-Terminal · /v1/dev/stripe-connect/refresh

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/dev/payouts/bank-accounts

Keycloak-Login

Ehemaliger Auszahlungsdaten-Endpunkt; antwortet dauerhaft mit 410, da Stripe Connect zuständig ist.

Parameter: Keine.
Antwort: {"error":{"code":"PAYOUTS_MOVED_TO_STRIPE","message":"…"}}

JKz API Web-Terminal · /v1/dev/payouts/bank-accounts

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/dev/billing

Keycloak-Login

Liefert Pläne, Abonnements und Rechnungsübersicht des Entwicklers.

Parameter: Keine.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/dev/billing

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/dev/billing/checkout

Keycloak-Login

Erstellt eine Stripe-Checkout-Session für einen Entwicklerplan.

Parameter: JSON: gameUuid/game_uuid, planCode/plan_code.
Antwort: {"data":{"url":"https://…"}}

JKz API Web-Terminal · /v1/dev/billing/checkout

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/dev/billing/manage

Keycloak-Login

Verwaltet ein Entwickler-Abo (z. B. Wechsel oder Kündigung).

Parameter: JSON: action sowie je nach Aktion subscriptionUuid, gameUuid und planCode.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/dev/billing/manage

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/dev/billing/invoices/download

Keycloak-Login

Lädt eine eigene Entwicklerrechnung herunter.

Parameter: Query: invoiceUuid/invoice_uuid.
Antwort: [Binäre PDF-Antwort]

JKz API Web-Terminal · /v1/dev/billing/invoices/download

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/dev/store/seller-statements

Keycloak-Login

Listet eigene Verkäuferabrechnungen.

Parameter: Query: status, dateFrom/date_from, dateTo/date_to, limit.
Antwort: {"data":[]}

JKz API Web-Terminal · /v1/dev/store/seller-statements

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST /v1/dev/game-auth

Keycloak-Login

Listet/liest oder erstellt und aktualisiert JKz-Login-Clients eigener Spiele.

Parameter: GET: action=list|detail, id, gameUuid. POST: action und Client-Konfiguration (gameUuid, Redirect-URIs, Origins, Scopes).
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/dev/game-auth

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST /v1/dev/game-cloud

Keycloak-Login

Verwaltet GameCloud-Collections, Spalten, Schlüssel und Entwickleransichten von Datensätzen/Audit.

Parameter: GET: action, id, gameUuid, limit. POST: action sowie gameUuid, collectionId/id, columnId, key und aktionsbezogene Daten.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/dev/game-cloud

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST /v1/dev/game-server

Keycloak-Login

Verwaltet GameServer-Projekte, Räume, Matches, Ereignisse und Hosted-Instanzen eigener Spiele.

Parameter: GET: action, id/projectId und aktionsbezogene Filter. POST: action, projectId/id, gameUuid und aktionsbezogene Daten.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/dev/game-server

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST DELETE /v1/dev/in-app-purchases

Keycloak-Login

Listet und verwaltet In-App-Produkte eigener Spiele.

Parameter: GET: gameUuid. POST: action und Produktdaten. DELETE: itemUuid als Query.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/dev/in-app-purchases

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

4.11 Game-SDK

6 Routen

POST /v1/game-auth/token

Ohne Login

Tauscht einen OAuth-Code eines registrierten Spiel-Clients per PKCE oder erneuert dessen Token.

Parameter: JSON action=exchange: clientId, code, redirectUri, codeVerifier. action=refresh: clientId, refreshToken.
Antwort: {"data":{"accessToken":"…"}}

JKz API Web-Terminal · /v1/game-auth/token

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/game-auth/me

Game-Token

Liefert das freigegebene JKz-Profil für die Session eines registrierten Spiels.

Parameter: Query: gameUuid. Header: Bearer Game-Access-Token; optional X-JKZ-ID-Token.
Antwort: {"data":{"userId":"…"}}

JKz API Web-Terminal · /v1/game-auth/me

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Game-Bearer-Token gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST DELETE /v1/game-cloud/records

Game-Token

Liest, sucht, schreibt oder löscht GameCloud-Datensätze und Leaderboard-Einträge.

Parameter: GET: gameUuid, table/collection, key, action, limit, playerUserId, where, orderBy, direction, cursor. Schreiben: entsprechende JSON-Felder. Alternativ Header X-JKZ-GameCloud-Key.
Antwort: {"data":{"record":{}}}

JKz API Web-Terminal · /v1/game-cloud/records

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Game-Bearer-Token gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST /v1/game-server/runtime

Game-Token

Runtime-API für Polling, Räume, Matchmaking, State, Input, Ergebnisse und Fehlerberichte.

Parameter: GET: action=poll, gameUuid plus Cursor-/Raumparameter. POST: gameUuid und action (join, spectate, quick_join, list_rooms, send, poll, heartbeat, update_state, input, start_match, finish_match, submit_result, leave, disconnect, log_error).
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/game-server/runtime

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Game-Bearer-Token gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/game-server/hosted-routing

Ohne Login

Löst die öffentliche Route einer Hosted-GameServer-Instanz auf.

Parameter: Query: gameUuid/game_uuid oder slug; optional instanceKey/instance und purpose (Standard http).
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/game-server/hosted-routing

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST /v1/game-iap/items

Game-Token

Listet eigene In-App-Käufe im Spiel oder verbraucht ein Consumable.

Parameter: GET: gameUuid. POST: gameUuid, action=consume und Item-/Mengenfelder.
Antwort: {"data":{"items":[],"summary":{}}}

JKz API Web-Terminal · /v1/game-iap/items

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Game-Bearer-Token gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

4.12 GameStore

16 Routen

GET /v1/store/faq

Ohne Login

Listet veröffentlichte GameStore-FAQ-Einträge. Rollenpflichtige Schreibmethoden sind nicht Teil der öffentlichen Doku.

Parameter: Keine.
Antwort: {"ok":true,"data":{"items":[],"canManage":false}}

JKz API Web-Terminal · /v1/store/faq

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/store/seals

Ohne Login

Liefert öffentliche Seal-Definitionen und Zuordnungen. Admin-Suche/-Schreibaktionen sind ausgeschlossen.

Parameter: Query: userIds/users und/oder gameUuids/games als CSV.
Antwort: {"definitions":[],"data":[]}

JKz API Web-Terminal · /v1/store/seals

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST /v1/store/game-jams

Listet GameJams; angemeldete Nutzer können teilnehmen, verlassen, Spiele einreichen und abstimmen. Admin-Aktionen sind ausgeschlossen.

Parameter: GET action=list oder eligible mit jamId. POST action=participate|leave|submit|vote und aktionsbezogene Felder.
Antwort: {"data":[]}

JKz API Web-Terminal · /v1/store/game-jams

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST PUT DELETE /v1/store/cart

Keycloak-Login

Liest oder ändert den eigenen Warenkorb.

Parameter: Schreiben: action, gameUuid/gameUuids und inCart/cart. DELETE entfernt Einträge.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/store/cart

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/store/library

Keycloak-Login

Listet die eigene Spielebibliothek.

Parameter: Keine.
Antwort: {"data":[]}

JKz API Web-Terminal · /v1/store/library

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/store/downloads

Liefert Download-/Build-Metadaten eines Spiels, abhängig von Sichtbarkeit und Besitz.

Parameter: Query: id oder gameUuid.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/store/downloads

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/store/downloads/waiver

Keycloak-Login

Dokumentiert den Verzicht auf das Widerrufsrecht für einen digitalen Download.

Parameter: JSON: buildUuid/buildId und digitalContentWaiverAccepted/digitalWaiverAccepted=true.
Antwort: {"success":true}

JKz API Web-Terminal · /v1/store/downloads/waiver

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/store/downloads/file

Keycloak-Login

Lädt einen gekauften/freigegebenen Spiel-Build herunter.

Parameter: Query: buildUuid/buildId; optional source=web|launcher.
Antwort: [Binäre Datei-Antwort]

JKz API Web-Terminal · /v1/store/downloads/file

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/store/in-app-purchases

Listet kaufbare In-App-Produkte eines Spiels; Login ergänzt Besitz-/Verfügbarkeitsdaten.

Parameter: Query: gameUuid oder id.
Antwort: {"data":[]}

JKz API Web-Terminal · /v1/store/in-app-purchases

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/store/in-app-purchases/session

Keycloak-Login

Erstellt eine Checkout-Session für ein In-App-Produkt.

Parameter: JSON: itemUuid, quantity sowie bestätigte Digital-Waiver-Felder.
Antwort: {"data":{"url":"https://…"}}

JKz API Web-Terminal · /v1/store/in-app-purchases/session

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/store/checkout/session

Keycloak-Login

Erstellt gruppierte Stripe-Checkout-Sessions für Spiele und/oder In-App-Produkte.

Parameter: JSON: gameUuids/gameIds, optional inAppItems, sowie bestätigte Digital-Waiver-Felder.
Antwort: {"data":{"checkoutGroupUuid":"…","sessions":[]}}

JKz API Web-Terminal · /v1/store/checkout/session

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/store/checkout/status

Keycloak-Login

Prüft den Status einer eigenen Checkout-Session oder Bestellung.

Parameter: Query: sessionId/checkout_session_id oder orderUuid.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/store/checkout/status

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/store/checkout/cancel

Keycloak-Login

Bricht offene eigene Checkout-Sessions einer Gruppe ab.

Parameter: JSON: checkoutGroupUuid/checkout_group_uuid oder sessionIds.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/store/checkout/cancel

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

POST /v1/store/orders/refund

Keycloak-Login

Fordert für eine eigene Bestellung eine Erstattung an.

Parameter: JSON oder Query: orderUuid/order_uuid, optional reason (Standard withdrawal).
Antwort: {"data":{"refundUuid":"…"}}

JKz API Web-Terminal · /v1/store/orders/refund

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET POST /v1/store/advancement/me

Keycloak-Login

Liest eigenen Store-Fortschritt/XP oder zeichnet eine zulässige Advancement-Aktion auf.

Parameter: POST: action, optional gameUuid, orderUuid, metadata.
Antwort: {"data":{}}

JKz API Web-Terminal · /v1/store/advancement/me

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

JSON-Body editierbar Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Achtung: Diese Route unterstützt echte Schreibzugriffe.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/store/seller-statements/download

Keycloak-Login

Lädt die Verkäuferabrechnung zu einer eigenen Bestellung, sofern die Verkäuferrolle passt.

Parameter: Query: orderUuid/order_uuid.
Antwort: [Binäre PDF-Antwort]

JKz API Web-Terminal · /v1/store/seller-statements/download

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

4.13 GameStore-Launcher

6 Routen

GET /v1/gamestore/client/win/version

Ohne Login

Liefert Windows-Client-Release-Metadaten oder das Tauri-v2-Updateformat.

Parameter: Query: channel, architecture/arch, format=jkz|tauri2, currentVersion/current_version.
Antwort: {"data":{"version":"…","downloadUrl":"…"}}

JKz API Web-Terminal · /v1/gamestore/client/win/version

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/gamestore/client/win/file

Ohne Login

Lädt das signierte Windows-Client-Artefakt mit Range-Unterstützung.

Parameter: Query: channel, architecture/arch.
Antwort: [Binäre Installer-Antwort]

JKz API Web-Terminal · /v1/gamestore/client/win/file

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/gamestore/game/build

Keycloak-Login

Liefert Metadaten des aktuellen launcherfähigen, gekauften Windows-Builds.

Parameter: Query: gameUuid/gameId, optional architecture.
Antwort: {"data":{"gameUuid":"…","buildUuid":"…"}}

JKz API Web-Terminal · /v1/gamestore/game/build

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/gamestore/game/manifest

Keycloak-Login

Liefert signiertes Launcher-Manifest eines gekauften Builds.

Parameter: Query: genau eines von gameUuid/gameId oder buildUuid/buildId; optional platform=windows, architecture.
Antwort: {"data":{"payload":"BASE64","manifestSha256":"…","signature":"…"}}

JKz API Web-Terminal · /v1/gamestore/game/manifest

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/gamestore/game/archive

Keycloak-Login

Lädt das vollständige gekaufte Spielarchiv mit Range-Unterstützung.

Parameter: Query: buildUuid/buildId, optional architecture.
Antwort: [Binäres ZIP-Archiv]

JKz API Web-Terminal · /v1/gamestore/game/archive

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

GET /v1/gamestore/game/file

Keycloak-Login

Lädt eine einzelne, im signierten Manifest enthaltene Datei.

Parameter: Query: buildUuid/buildId, fileId (SHA-256), optional architecture.
Antwort: [Binäre Datei-Antwort]

JKz API Web-Terminal · /v1/gamestore/game/file

Aufruf Felder können direkt angepasst werden

Methode Request-URL

https://api.jkz-group.de

Zusätzliche Header (JSON) optional Bearer-Token überschreiben gilt nur für diesen Aufruf

Die Antwort kommt live vom Endpoint.

Antwort Live-Ausgabe des Endpoints

Bereit.

Noch kein Aufruf ausgeführt.

JKz-API v1Öffentliche Endpoints & Integration

Inhaltsverzeichnis

1. Grundlagen

Basis-URL

Bearer-Token

Sicher testen

2. Authentifizierung

Keycloak-Sitzung für das Web-Terminal

3. Code-Beispiele

4. Öffentliche Endpoints

4.1 System & Allgemein

4.2 Badges

4.3 Chat

4.4 Nutzer & Profile

4.5 Beziehungen & Datenschutz

4.6 Nachrichten & Sicherheit

4.7 Meldungen

4.8 Spielekatalog

4.9 Spiele veröffentlichen

4.10 Developer-Portal

4.11 Game-SDK

4.12 GameStore

4.13 GameStore-Launcher

JKz-API v1
Öffentliche Endpoints & Integration