diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 000000000..e69de29bb diff --git a/404.html b/404.html new file mode 100644 index 000000000..41f97f15e --- /dev/null +++ b/404.html @@ -0,0 +1,1545 @@ + + + +
+ + + + + + + + + + + + + + +OpenAPI: (noch nicht verfügbar)
+Gibt eine Übersicht aller Gruppen und deren Mitglieder zurück.
+Einschränkung: 🔓
+GET /unicacityaddon/v1/{tokenString}/player
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
Gibt eine Übersicht aller Gruppen zurück.
+Einschränkung: 🔓
+GET /unicacityaddon/v1/{tokenString}/player/groups
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
Fügt den angegebenen Spieler der angegebenen Gruppe hinzu.
+Einschränkung: 🔒 (Administratoren)
+GET /unicacityaddon/v1/{tokenString}/player/add?name={name}&group={group}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
name |
+Minecraft Name des Spielers | +
group |
+Name der Gruppe | +
Entfernt den angegebenen Spieler aus der angegebenen Gruppe.
+Einschränkung: 🔒 (Administratoren)
+GET /unicacityaddon/v1/{tokenString}/player/remove?name={name}&group={group}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
name |
+Minecraft Name des Spielers | +
group |
+Name der Gruppe | +
Deactivated
+Dieser Endpunkt ist zur Zeit nicht in Verwendung. Durch eine Unicacity Richtlinie ist die Verwendung dieses Features +aktuell deaktiviert.
+OpenAPI: (noch nicht verfügbar)
+Gibt eine Übersicht aller Auto-NC Schlüsselwörter und Antworten.
+Einschränkung: 🔓
+GET /unicacityaddon/v1/{tokenString}/autonc
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
Gibt eine Übersicht aller Gruppen zurück.
+Einschränkung: 🔐
+GET /unicacityaddon/v1/{tokenString}/autonc/add?words={words}&answer={answer}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
words |
+Wörter (Wort1,Wort2,Wort3,...) | +
answer |
+Antwort | +
Fügt den angegebenen Spieler der angegebenen Gruppe hinzu.
+Einschränkung: 🔒 (Administratoren)
+GET /unicacityaddon/v1/{tokenString}/autonc/remove?id={id}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
id<br/> |
+ID des zu löschenden Eintrags | +
OpenAPI: (noch nicht verfügbar)
+Zeigt alle registrierten Banner an und eine Übersicht über die Banner-Aufteilung auf Fraktionen für die letzten 24 +Stunden.
+Tip
+Durch diesen Enpunkt wird die Übersicht der Banner und deren Verlauf generiert. Siehe: +Banner
+Einschränkung: 🔓
+GET /unicacityaddon/v1/{tokenString}/banner
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
Fügt ein neues Banner hinzu.
+Einschränkung: 🔓
+GET /unicacityaddon/v1/{tokenString}/banner/add?faction={faction}&x={x}&y={y}&z={z}&navipoint={navipoint}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
faction |
+Fraktion die das Banner übersprüht hat | +
x |
+X Koordinate des Banners | +
y |
+Y Koordinate des Banners | +
z |
+Z Koordinate des Banners | +
navipoint |
+Navipunkt in der Nähe des Banners | +
OpenAPI: (noch nicht verfügbar)
+Zeigt die Blacklist-Gründe für die angegebene Fraktion an.
+Einschränkung: 🔐 Mitglieder der angegebenen Fraktion
+GET /unicacityaddon/v1/{tokenString}/blacklistreason/{factionString}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
factionString |
+Fraktion | +
Fügt einen neuen Blacklist-Grund zur angegebenen Fraktion hinzu.
+Einschränkung: 🔐 Mitglieder (Rang 4+) der angegebenen Fraktion
+GET /unicacityaddon/v1/{tokenString}/blacklistreason/{factionString}/add?reason={reason}&price={price}&kills={kills}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
factionString |
+Fraktion des neuen Blacklist-Grundes | +
reason |
+Grund | +
price |
+Preis | +
kills |
+Kills | +
Warning
+Der Grund muss mit "-" als Leerzeichen angegeben werden!
+Entfernt einen Blacklist-Grund von der angegebenen Fraktion.
+Einschränkung: 🔐 Mitglieder (Rang 4+) der angegebenen Fraktion
+GET /unicacityaddon/v1/{tokenString}/blacklistreason/{factionString}/remove?reason={reason}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
factionString |
+Fraktion des neuen Blacklist-Grundes | +
reason |
+Grund | +
Warning
+Der Grund muss mit "-" als Leerzeichen angegeben werden!
+OpenAPI: (noch nicht verfügbar)
+Zeigt die Schwarzmarkt-Positionen.
+Einschränkung: 🔓
+GET /unicacityaddon/v1/{tokenString}/blackmarket
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
OpenAPI: (noch nicht verfügbar)
+Zeigt die Daten für aktuelle Events.
+Einschränkung: 🔓
+GET /unicacityaddon/v1/{tokenString}/event
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
Fügt ein Bankraub Event hinzu.
+Einschränkung: 🔐
+GET /unicacityaddon/v1/{tokenString}/event/bankrob?startTime={startTime}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
startTime |
+Zeitpunkt des Event-Starts | +
Fügt ein Bomben Event hinzu.
+Einschränkung: 🔐
+GET /unicacityaddon/v1/{tokenString}/event/bomb?startTime={startTime}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
startTime |
+Zeitpunkt des Event-Starts | +
Setzt die aktuelle Punktzahl für Angreifer und Verteidiger während eines Gangwars.
+Tip
+Diese Funktion wird vom UnicaCity Event Team genutzt um während eines Twitch-Streams den aktuellen Punktestand +anzuzeigen. Siehe: Gangwar Übersicht
+Einschränkung: 🔓
+GET /unicacityaddon/v1/{tokenString}/event/gangwar?attacker={attacker}&defender={defender}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
attacker |
+Punktestand der Angreifer | +
defender |
+Punktestand der Verteidiger | +
Note
+Experimentelles Feature! Das Feature ist noch in der Entwicklung.
+Beispiel: Rettungsdienst (längere Ladezeit +möglich)
+ + + + + + +OpenAPI: (noch nicht verfügbar)
+Zeigt die Hausverbot-Gründe an.
+Einschränkung: 🔓
+GET /unicacityaddon/v1/{tokenString}/housebanreason
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
Fügt einen neuen Hausverbot-Grund hinzu.
+Einschränkung: 🔐 Mitglieder (Rang 4+) des Rettungsdienstes
+GET /unicacityaddon/v1/{tokenString}/housebanreason/add?reason={reason}&days={days}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
reason |
+Hausverbot-Grund | +
days |
+Anzahl der Tage | +
Warning
+Der Grund muss mit "-" als Leerzeichen angegeben werden!
+Entfernt einen Hausverbot-Grund.
+Einschränkung: 🔐 Mitglieder (Rang 4+) des Rettungsdienstes
+GET /unicacityaddon/v1/{tokenString}/housebanreason/remove?reason={reason}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
reason |
+Hausverbot-Grund | +
Warning
+Der Grund muss mit "-" als Leerzeichen angegeben werden!
+OpenAPI: (noch nicht verfügbar)
+Zeigt die aktuellen Hausverbote an.
+Einschränkung: 🔓 / 🔐 (für advanced = true
Mitglieder des Rettungsdienstes)
GET /unicacityaddon/v1/{tokenString}/houseban?advanced={advanced}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
advanced |
+false defaulttrue zeigt an, wer das Hausverbot eingetragen hat |
+
Fügt dem angegebenen Spieler den angegebenen Hausverbot-Grund hinzu.
+Einschränkung: 🔐 Mitglieder (Rang 4+) des Rettungsdienstes
+GET /unicacityaddon/v1/{tokenString}/houseban/add?name={name}&reason={reason}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
name |
+Minecraft Name des Spielers | +
reason |
+Hausverbot-Grund | +
Warning
+Der Grund muss mit "-" als Leerzeichen angegeben werden!
+Entfernt dem angegebenen Spieler den angegebenen Hausverbot-Grund.
+Einschränkung: 🔐 Mitglieder (Rang 4+) des Rettungsdienstes
+GET /unicacityaddon/v1/{tokenString}/houseban/remove?name={name}&reason={reason}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
name |
+Minecraft Name des Spielers | +
reason |
+Hausverbot-Grund | +
Warning
+Der Grund muss mit "-" als Leerzeichen angegeben werden!
+Deprecated
+Dieser Endpunkt ist veraltet und wird in einer zukünftigen Version entfernt.
+Dieser Endpunkt wurde nur für die Migration von JSON-Dateien zur Datenbank genutzt. Es mussten die Inhalte der Dateien +in die Datenbank eingetragen werden. Um dies durchzuführen wurde dieser Endpunkt erstellt. Aktuell wird er nicht +genutzt.
+Einschränkung: 🔒 (Administratoren)
+GET /unicacityaddon/v1/{tokenString}/load
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
OpenAPI: (noch nicht verfügbar)
+Zeigt Daten wie Client Anzahl, Versionsverteilung oder aktuelle Version an.
+Einschränkung: 🔓
+GET /unicacityaddon/v1/{tokenString}/mgmt
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
Zeigt alle registrierten Clients mit der Aktivität, Version, UUID und Versionsaktualität an.
+Einschränkung: 🔓
+GET /unicacityaddon/v1/{tokenString}/mgmt/users
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
Markiert eine Version als aktuell oder veraltet.
+Einschränkung: 🔒 (Administratoren)
+GET /unicacityaddon/v1/{tokenString}/mgmt/version?type={type}&version={version}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
type |
+Version als aktuell (add ) oder veraltet (remove ) markieren |
+
version |
+Version, die markiert werden soll (z. B.: 1.0.0 oder 1.45.2 ) |
+
OpenAPI: (noch nicht verfügbar)
+Zeigt die Navi-Punkte an.
+Einschränkung: 🔓
+GET /unicacityaddon/v1/{tokenString}/navipoint
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
Fügt einen neuen Navi-Punkt hinzu.
+Einschränkung: 🔒 (Administratoren)
+GET /unicacityaddon/v1/{tokenString}/navipoint/add?name={name}&x={x}&y={y}&z={z}&article={article}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
name |
+Name des Navi-Punktes | +
x |
+X Koordinate des Navi-Punktes | +
y |
+Y Koordinate des Navi-Punktes | +
z |
+Z Koordinate des Navi-Punktes | +
article |
+Artikel des Navi-Punktes (der/die/das) | +
Warning
+Der Name muss mit "-" als Leerzeichen angegeben werden!
+Note
+Der Artikel wird benötigt, da es einen Anwendungsfall gibt, für den der Navi-Punkt mit dem Artikel angezeigt werden +muss. Für die Sperrgebiet-Nachricht muss der Artikel automatisiert zur Verfügung gestellt werden.
+Entfernt einen Navi-Punkt.
+Einschränkung: 🔒 (Administratoren)
+GET /unicacityaddon/v1/{tokenString}/navipoint/remove?name={name}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
name |
+Name des Navi-Punktes | +
Warning
+Der Name muss mit "-" als Leerzeichen angegeben werden!
+OpenAPI: (noch nicht verfügbar)
+Fügt einen neuen Revive hinzu.
+Einschränkung: 🔐 Mitglieder des Rettungsdienstes
+GET /unicacityaddon/v1/{tokenString}/revive
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
Zeigt die Revive-Anzahl aller Spieler des angegebenen Rangs oder die Revive-Anzahl des angegebenen Spielers an.
+Einschränkung: 🔐 angegebener Spieler oder Mitglieder (Rang 4+) des Rettungsdienstes
+GET /unicacityaddon/v1/{tokenString}/revive/{playerOrRank}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
playerOrRank |
+Minecraft Name des Spielers oder Rang | +
OpenAPI: (noch nicht verfügbar)
+Zeigt alle UUID mit ihrem zugehörigen Roleplay Namen an.
+Einschränkung: 🔓
+GET /unicacityaddon/v1/{tokenString}/roleplay
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
Aktualisiert Roleplay Daten. Es werden die Daten aktualisiert, die zum angegeben API Token gehören. Somit kann nur jeder +seine eigenen Daten ändern.
+Einschränkung: 🔓
+GET /unicacityaddon/v1/{tokenString}/roleplay/update?name={name}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
name |
+Namen der als Roleplay Name gesetzt werden soll | +
OpenAPI: (noch nicht verfügbar)
+Zeigt die Top-Liste mit verschiedenen Kategorien an.
+Einschränkung: 🔓
+GET /unicacityaddon/v1/{tokenString}/statistic/top
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
Zeigt die Statistiken des angegebenen Spielers an.
+Einschränkung: 🔓
+GET /unicacityaddon/v1/{tokenString}/statistic/{player}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
player |
+Minecraft Name oder Minecraft UUID des Spielers | +
Fügt einen Statistik-Eintrag dem angegebenen Spieler hinzu.
+Einschränkung: 🔐 angegebener Spieler
+GET /unicacityaddon/v1/{tokenString}/statistic/{player}/add?type={type}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
player |
+Minecraft Name oder Minecraft UUID des Spielers | +
type |
+Statistik-Typ | +
Quote
+Hey Rettich, warum machst du das öffentlich? Jetzt kann doch jeder sich seine Statistiken modifizieren...
+Ja das stimmt, aber: Man muss erstmal an sein eigenes Addon-Token rankommen. Das wird in den Client-Logs nicht +ausgegeben und müsste demnach generiert werden. Sollte das jemand getan haben und sich seine Statistiken +modifizieren, ist das auffälliger als man vielleicht denkt. Den Spieler erwartet dann entweder einen Reset der +Statistik oder einen Ausschluss von der API.
+Setzt einen Statistik-Eintrag für den angegebenen Spieler.
+Einschränkung: 🔒 (Administratoren)
+GET /unicacityaddon/v1/{tokenString}/statistic/{player}/set?type={type}&amount={amount}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
player |
+Minecraft Name oder Minecraft UUID des Spielers | +
type |
+Statistik-Typ | +
amount |
+Anzahl | +
OpenAPI: (noch nicht verfügbar)
+Überprüft die angegebenen Werte (siehe Autorisierung) und registriert nach +erfolgreicher Überprüfung das Token, durch das auf nicht öffentliche Endpunkte zugegriffen werden kann.
+Einschränkung: 🔓
+GET /unicacityaddon/v1/{tokenString}/create?authToken={authToken}&version={version}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
authToken |
+Mojang Session Token | +
version |
+Version des Clients (Addon-Version) | +
OpenAPI: (noch nicht verfügbar)
+Zeigt die Wanted-Liste an.
+Einschränkung: 🔓
+GET /unicacityaddon/v1/{tokenString}/wantedreason
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
Fügt einen neuen Wanted-Grund zur Wanted-Liste hinzu.
+Einschränkung: 🔐 Mitglieder (Rang 4+) der Polizei
+GET /unicacityaddon/v1/{tokenString}/wantedreason/add?reason={reason}&points={points}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
reason |
+Wanted-Grund | +
points |
+Anzahl an Wanted-Punkten | +
Entfernt einen Wanted-Grund von der Wanted-Liste.
+Einschränkung: 🔐 Mitglieder (Rang 4+) der Polizei
+GET /unicacityaddon/v1/{tokenString}/wantedreason/remove?reason={reason}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
reason |
+Wanted-Grund | +
OpenAPI: (noch nicht verfügbar)
+Zeigt die Yasin-Liste an.
+Einschränkung: 🔓
+GET /unicacityaddon/v1/{tokenString}/yasin
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
Fügt einen neuen Spieler zur Yasin-Liste hinzu.
+Einschränkung: 🔐 Yasin
+GET /unicacityaddon/v1/{tokenString}/yasin/add?name={name}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
name |
+Minecraft Name des Spielers | +
Markiert einen Spieler auf der Yasin-Liste als erledigt.
+Einschränkung: 🔐 Yasin
+GET /unicacityaddon/v1/{tokenString}/yasin/done?name={name}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
name |
+Minecraft Name des Spielers | +
Entfernt einen Spieler von der Yasin-Liste.
+Einschränkung: 🔐 Yasin
+GET /unicacityaddon/v1/{tokenString}/yasin/remove?name={name}
Parameter | +Beschreibung | +
---|---|
tokenString |
+Addon-Token | +
name |
+Minecraft Name des Spielers | +
Die Autorisierung ist ein wichtiger Bestandteil, da nicht jeder Spieler alle Daten sehen darf. Zum Beispiel darf ein +Mitglied des Rettungsdienstes lediglich seine eigene Anzahl an Wiederbelebungen sehen. Ab einem bestimmten Rang muss +das Rettungsdienst-Mitglied allerdings alle Wiederbelebungen, also auch die anderer Spieler, sehen könne.
+Um eine Autorisierung zu gewährleisten, besitzt jeder Spieler ein eindeutiges Addon-Token. Bei jedem Spielstart wird +dieses Addon-Token neu generiert und bietet somit eine höhere Sicherheit, da es sich somit fast täglich ändert. Das +Addon-Token besteht aus einem Hash des LabyConnect JWT Tokens und der Minecraft UUID des Nutzers. Bei der Erstellung des +neuen Addon-Tokens wird dieses mit dem LabyConnect JWT Token an die API gesendet.
+Die API verifiziert das JWT Token mit dem öffentlichen LabyConnect Schlüssel. Wenn das JWT Token gültig ist, werden die +Inhalte des Tokens encoded (Beispiel):
+{
+ "user_name": "RettichLP",
+ "roles": [
+ "ROLE_DEVELOPER",
+ "ROLE_PLUS"
+ ],
+ "iss": "LabyConnect",
+ "exp": 1689588000,
+ "uuid": "25855f4d-3874-4a7f-a6ad-e9e4f3042e19",
+ "iat": 1689584400
+}
+
Die Minecraft UUID wird anschließend mit der gehashten Minecraft UUID im generiertem Addon-Token verglichen. Stimmen +beide überein, ist das Addon-Token valide und gehört zum mitgesendetem LabyConnect JWT Token. Anhand der Minecraft UUID +können die Berechtigungen des Spielers (z. B. von der UnicaCity Webseite) ausgelesen werden.
+Das Addon-Token wird mit der Minecraft UUID und dem Minecraft Namen gespeichert. Somit ist es nicht notwendig die Mojang +API aufzurufen, wenn man eine Minecraft UUID einem Minecraft Namen zuordnen möchte. Das LabyConnect JWT Token wird nicht +gespeichert und nur geloggt, wenn es nicht gültig ist um eine Fehleranalyse zu ermöglichen.
+ + + + + + + +Es werden für die Einträge in die Datenbank JPA-Entities verwendet. Diese Entities verwenden jeweils folgende Daten:
+Speichert Spieler und (sofern zugeordnet) deren Gruppen.
+minecraftUuid
Minecraft UUID des SpielersgroupList
Liste aus Gruppen, zu denen der Spieler gehörtSpeichert Schlüsselwörter oder Symbole und eine Antwort.
+words
Liste aus Wörtern oder Symbolenanswer
Antwort TextSpeichert den Banner-Status.
+x
X Koordinate des Bannersy
Y Koordinate des Bannersz
Z Koordinate des BannersnaviPoint
Navipunkt der in der Nähe liegttime
Zeitpunkt der letzten Übersprühung des BannersSpeichert die Blacklist-Gründe.
+reason
Grundkills
Anzahl der Killsprice
GeldbetragissuerMinecraftUuid
Minecraft UUID des Spielers, der den Blacklist-Grund hinzugefügt hatfaction
Fraktion, der der Blacklist-Grund gehörtSpeichert Spieler mit einem Hausverbot im Krankenhaus/in der Feuerwache.
+minecraftUuid
Minecraft UUID des SpielersstartTime
Zeitpunkt der Hausverbot-VergabehouseBanReasonList
Liste von Hausverbot-GründenSpeichert Hausverbot-Gründe.
+reason
Hausverbot-Grunddays
Hausverbot-Länge in TagenissuerMinecraftUuid
Minecraft UUID des Spielers, der den Hausverbot-Grund hinzugefügt bzw. vergeben hatSpeichert Navipunkte.
+name
Namex
X Koordinate des Navi-Punktesy
Y Koordinate des Navi-Punktesz
Z Koordinate des Navi-Punktesarticle
Artikel (der/die/das)Speichert die Anzahl der Revives von Mitgliedern des Rettungsdienstes. Da die Auswertung der Revive Anzahl wöchentlich +passiert, werden Revives maximal 2 Wochen gespeichert. Anschließend werden diese automatisch gelöscht.
+user
Usertime
Zeitpunkt des RevivesNote
+Hier wird statt der Minecraft UUID der User genommen. Das liegt daran, dass dieses Datenbank Entity neu ist und die +älteren noch nicht von Minecraft UUID auf User geändert wurden.
+Speichert die Roleplay Daten der User.
+name
Roleplay Name des UsersSpeichert die Statistik der User.
+deaths
Todekd
KDkills
KillsplayTime
Spielzeitrevives
Anzahl aller Revivesservices
Anzahl aller ServicesNote
+Die Anzahl aller Revives wird nicht gelöscht. Im Gegensatz zu Revive bleibt diese Zahl erhalten.
+Speichert das Token eines Users.
+user
Usertoken
TokencreationTime
Zeitpunkt der Erstellungversion
Version mit der das Token erstellt wurde (Addon-Version des Spielers)Speichert den User.
+minecraftUuid
Minecraft UUID des Spielerspassword
Passwort (aktuell nicht in Verwendung - Platzhalter für ein zukünftiges Web-Interface für Statistiken)faction
FraktionrankInFaction
Rang in der FraktionSpeichert die Wanted-Gründe.
+reason
Wanted-GrundwantedPoints
Anzahl Wanted-PunkteSpeichert die Yasin-Liste.
+minecraftUuid
Minecraft UUID des Spielersdone
Erledigt/noch offenFür manche Funktionen wie zum Beispiel Hausverbote, braucht man einen zentralen Speicher, um diese allen Spielern zur +Verfügung zu stellen. Des Weiteren ist durch einen zentralen Speicher auch eine schnellere Anpassung möglich. Wenn +beispielsweise ein neuer Navipunkt hinzugefügt werden soll, muss man nicht auf ein Update warten. Durch die API kann +direkt über das Spiel, durch einen Command, der Navipunkte hinzugefügt werden.
+Ein weiterer wichtiger Grund war die Sicherheit von Daten. Wir haben eine Liste von Navipunkten von
+UnicaCity bekommen unter der Voraussetzung, dass diese nicht veröffentlicht wird. Vor der API
+haben wir das über ein Environment Secret in GitHub gelöst. Durch die API ist es möglich die Liste über einen
+Endpunkt bereitzustellen. Den Zugriff auf diese Endpunkte können wir besser schützen und
+die Liste ist nicht mehr durch Dekompilierung der .jar
Datei zu finden.
Die API stellt mehrere Endpunkte zur Verfügung. Alle Endpunkte starten mit der Base-Url: https://rettichlp.de:8443/
.
+Anschließend wird der Pfad der Anwendung und die API Version angegeben: unicacityaddon/v1/
. Da nicht jeder Zugriff auf
+jeden Endpunkt haben soll, muss das Addon-Token angegeben werden (siehe
+Autorisierung). Danach wird der Endpunkt definiert und bei Bedarf Parameter
+übergeben.
Base-Url:
+ +Geplant ist es eine Postman Collection zur Verfügung zu stellen. Das wird nachgeholt, wenn die Zeit da ist.
+Eine OpenAPI soll ebenfalls hinzugefügt und auch in den Code eingebaut werden. Dafür fehlt jedoch auch noch die Zeit. +Die Datei wird in jedem Endpunkt am Anfang herunterladbar sein.
+ + + + + + +