MUPLAGA REST-API

Version 1.0.0. Basis-URL /api/v1. Maschinenlesbare Spezifikation: OpenAPI (JSON).

Gemeinsame REST-API für Website, iOS- und Android-App. Website: Cookie-Sitzung (mpg_session). Apps: Bearer-Token aus /auth/login mit client=ios|android. Gäste: Cookie mpg_guest bzw. Header X-Guest-Key (wird beim ersten Spielstart erzeugt und im Response-Header X-Guest-Key zurückgegeben). Alle Fehler haben das Format {"error":{"code","message","details"}}. Zustandsändernde Cookie-Anfragen müssen von der eigenen Origin stammen (CSRF-Schutz).

MethodePfadBeschreibung
GET/healthHealth-Check (DB-Verbindung, Version)
POST/auth/registerRegistrierung; antwortet immer 202 (keine Konto-Enumeration), Bestätigungsmail folgt
POST/auth/verifyE-Mail-Adresse mit Token aus der Mail bestätigen
POST/auth/verify/resendBestätigungsmail erneut senden (immer 202)
POST/auth/loginAnmeldung; übernimmt Gast-Spielstände (Cookie/X-Guest-Key) ins Konto
POST/auth/logoutAbmelden (beendet die aktuelle Sitzung)
POST/auth/refreshToken rotieren (Apps); altes Token wird ungültig
POST/auth/password/forgotReset-Link anfordern (immer 202)
POST/auth/password/resetNeues Passwort mit Reset-Token setzen; beendet alle Sitzungen
POST/auth/password/changePasswort ändern (aktuelles Passwort nötig); andere Sitzungen werden beendet
POST/auth/external/{provider}Vorbereitet: Sign in with Apple, Google Sign-In, Game Center, Play Games (derzeit 501)
GET/meEigenes Profil
PATCH/meAnzeigename/Sprache ändern
DELETE/meKonto mit allen Daten löschen (Passwort nötig)
GET/me/exportDatenexport (JSON) nach Art. 15/20 DSGVO
GET/me/statsPersönliche Statistik, letzte Ergebnisse, Erfolge
GET/me/identitiesVerknüpfte externe Identitäten (Auth-Anbieter und Gaming-Plattformen)
GET/gamesAlle Spiele inkl. angekündigter
GET/games/{game}Spielinfo, Schwierigkeitsgrade, aktuelles Regelwerk
GET/games/{game}/levels/{id}Level per dauerhafter ID (ohne Lösung)
GET/games/{game}/dailyTagesrätsel (heute oder ?day=JJJJ-MM-TT in der Vergangenheit)
GET/sessionsOffene Spiele (Konto oder Gast) zum Fortsetzen
POST/sessionsSpiel starten (Level-ID, Schwierigkeit, Tagesrätsel oder Challenge); setzt laufendes Spiel auf demselben Level fort
GET/sessions/{id}Spielstand laden (geräteübergreifend)
PUT/sessions/{id}/progressFortschritt speichern; revision muss aktuell sein, sonst 409 PROGRESS_CONFLICT mit aktuellem Stand
POST/sessions/{id}/pausePause (Serverzeit stoppt)
POST/sessions/{id}/resumeFortsetzen
POST/sessions/{id}/hintTipp (nur Übungsmodus)
POST/sessions/{id}/checkFehlerprüfung gegen die Lösung (nur Übungsmodus)
POST/sessions/{id}/submitLösung abgeben; Server prüft Lösung und Zeit; idempotent (ein Ergebnis je Sitzung)
GET/leaderboards/{game}/levels/{id}Bestenliste eines Levels
GET/leaderboards/{game}/dailyTagesrätsel-Bestenliste (?day=)
GET/leaderboards/{game}/difficulty/{difficulty}Rangliste je Schwierigkeitsgrad (Anzahl Erstlösungen, Bestzeit)
GET/leaderboards/weeklyMeistgelöste Spieler der letzten 7 Tage
GET/challengesEigene erstellte und angenommene Herausforderungen
POST/challengesHerausforderung aus einem Level erstellen
GET/challenges/{code}Herausforderung mit Teilnehmenden und Ergebnissen
DELETE/challenges/{code}Link widerrufen (nur erstellende Person)
POST/challenges/{code}/joinHerausforderung annehmen
POST/challenges/{code}/closeHerausforderung beenden (nur erstellende Person)