Hinweis zu "/api/games", games2 und games3: Das Ziel ist, dass die APIv2 zukünftig unter
/api/games erreichbar ist. Das soll dazu dienen, migrieren zu können ohne die User auszusperren
user
games
-
/api/games/44773
APIv2
-
/api/games/44773?mapcode=1
APIv2
-
/api/games/44773?mapcode=1&players=1
APIv2
-
/api/games/44773?players=1
APIv2
-
/api/games/44773?moves=1
APIv2
-
/api/games2?user=1
APIv2, gerade teilweise von App genutzt, soll aber wieder weg, deprecated
-
/api/games2?user=1&finished=true
APIv2, deprecated
-
/api/games2?user=1&finished=true&limit=1&offset=300
APIv2, deprecated
-
/api/games2?user=1&limit=2&offset=3000
APIv2, deprecated
-
/api/games3
APIv2, Verhalten und Parameter siehe "/spiele/", Defaults beachten
-
/api/games3?mine=0&sort=gid
APIv2, wird /games sobald die App darauf umgestellt ist
-
/api/games3?sort=gid
APIv2, wird /games sobald die App darauf umgestellt ist
-
/api/games3?user=1&sort=gid
APIv2, wird /games sobald die App darauf umgestellt ist
-
/api/games3?user=1&finished=true
APIv2, wird /games sobald die App darauf umgestellt ist
-
/api/games3?name=papier&nameStart=0&mine=0
APIv2, Suche nach Begriff irgendwo im Titel
-
/api/games3?user=1&finished=true&limit=1&offset=300
APIv2, wird /games sobald die App darauf umgestellt ist
-
/api/games3?user=1&limit=2&offset=3000
APIv2, wird /games sobald die App darauf umgestellt ist
-
/api/games?user=1
Legacy API, deprecated
-
/api/games?user=1&finished=true
Legacy API, deprecated
-
/api/games?user=1&finished=true&limit=1&offset=300
Legacy API, deprecated
-
/api/games?user=1&limit=2&offset=3000
Legacy API, deprecated
maps
mapimages
chat
messaging
misc
deprecated/obsolete - or dead
obsolete/legacy - slow or dead
external
Zusatzinfos und nicht testbare Requests
- API Auth
- Settings
- Sendmail: GET/PATCH: /api/usersettings/sendmail (für Zug-Benachrichtigung per Email)
- Favoriten
- Favouriten: PUT: /api/user/favs/12345
- Favouriten: DELETE: /api/user/favs/12345
- Notizen
- PUT: /api/notes/12345 -- JSON-Body {text:"Merken: Nicht letzter werden"}
- DELETE: /api/notes/12345 (oder Body mit leerem Text, also {text:""})
- DELETE: /api/notes/12345 (oder Body mit leerem Text, also {text:""})
- Planned Moves PUT: /api/planned-moves/12345 -- JSON-Body
[{x:"1",y:"2",xv:"3",yv:"-4"},{...}]
- Chat-Nachricht POST /api/chat -- JSON-Body {msg: 'Mein Nachricht im Chat'}
Optional ein
ref: 123456
mitschicken, was eine id-Referenz auf eine existierende Nachricht ist
- Neues Spiel Am besten hier das Beispiel anschauen
- Aussteigen DELETE /games/12345
- Zettel
- Neue Nachricht: POST /api/messages/1 -- JSON body mit {text: "Hallo Didi!"}
- Zettel Lesebestätigung: PATCH /api/messages/1 -- Setzt dann den "Unread Counter" uc, also
ungelesene pro Kontakt zurück
- Previews Wenn ein Thumbnail für ein Spiel fehlt, POST /api/preview/{game_id} und der
Generator macht das Bild
Dies soll zur Dokumentation der bisherigen verfügbaren API-Calls dienen.
Vorschläge bitte PER EMAIL!