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).
| Methode | Pfad | Beschreibung |
|---|---|---|
GET | /health | Health-Check (DB-Verbindung, Version) |
POST | /auth/register | Registrierung; antwortet immer 202 (keine Konto-Enumeration), Bestätigungsmail folgt |
POST | /auth/verify | E-Mail-Adresse mit Token aus der Mail bestätigen |
POST | /auth/verify/resend | Bestätigungsmail erneut senden (immer 202) |
POST | /auth/login | Anmeldung; übernimmt Gast-Spielstände (Cookie/X-Guest-Key) ins Konto |
POST | /auth/logout | Abmelden (beendet die aktuelle Sitzung) |
POST | /auth/refresh | Token rotieren (Apps); altes Token wird ungültig |
POST | /auth/password/forgot | Reset-Link anfordern (immer 202) |
POST | /auth/password/reset | Neues Passwort mit Reset-Token setzen; beendet alle Sitzungen |
POST | /auth/password/change | Passwort ä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 | /me | Eigenes Profil |
PATCH | /me | Anzeigename/Sprache ändern |
DELETE | /me | Konto mit allen Daten löschen (Passwort nötig) |
GET | /me/export | Datenexport (JSON) nach Art. 15/20 DSGVO |
GET | /me/stats | Persönliche Statistik, letzte Ergebnisse, Erfolge |
GET | /me/identities | Verknüpfte externe Identitäten (Auth-Anbieter und Gaming-Plattformen) |
GET | /games | Alle 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}/daily | Tagesrätsel (heute oder ?day=JJJJ-MM-TT in der Vergangenheit) |
GET | /sessions | Offene Spiele (Konto oder Gast) zum Fortsetzen |
POST | /sessions | Spiel 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}/progress | Fortschritt speichern; revision muss aktuell sein, sonst 409 PROGRESS_CONFLICT mit aktuellem Stand |
POST | /sessions/{id}/pause | Pause (Serverzeit stoppt) |
POST | /sessions/{id}/resume | Fortsetzen |
POST | /sessions/{id}/hint | Tipp (nur Übungsmodus) |
POST | /sessions/{id}/check | Fehlerprüfung gegen die Lösung (nur Übungsmodus) |
POST | /sessions/{id}/submit | Lö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}/daily | Tagesrätsel-Bestenliste (?day=) |
GET | /leaderboards/{game}/difficulty/{difficulty} | Rangliste je Schwierigkeitsgrad (Anzahl Erstlösungen, Bestzeit) |
GET | /leaderboards/weekly | Meistgelöste Spieler der letzten 7 Tage |
GET | /challenges | Eigene erstellte und angenommene Herausforderungen |
POST | /challenges | Herausforderung aus einem Level erstellen |
GET | /challenges/{code} | Herausforderung mit Teilnehmenden und Ergebnissen |
DELETE | /challenges/{code} | Link widerrufen (nur erstellende Person) |
POST | /challenges/{code}/join | Herausforderung annehmen |
POST | /challenges/{code}/close | Herausforderung beenden (nur erstellende Person) |