GET /infecte/get-settings

version 2.0.3

Récupérer les paramètres infecté du joueur.

Authentification

Cette route nécessite de mettre votre clé API dans le Header.

👥 Autorisation

Les personnes autorisées pour utiliser cette requête sont :

• Corail
• Zelta

🧾 Paramètres

Le paramètre suivant est requis dans l’URL pour identifier le joueur :

Nom	Type	Dans	Requis	Description	Valeur par default
playerId	number	URL	✅	L'id du joueur	❌

🧾 Réponse

Les données que l'API retournera avec le succès de la requête :

Nom	Type	Nullable	Description
playerId	number	❌	L'id du joueur
rate	bool	❌	Si on affiche le gui de vote
achievementSound	bool	❌	Si on diffuse le son des achievements
scoreboard	bool	❌	Si on affiche le scoreboard
weather	string	✅	La météo de la map
chestplate	string	✅	La couleur du plastron

📤 Exemple de requête

http://0.0.0.0/api/infecte/get-settings?playerId=2

📥 Exemple de réponse

Si le joueur est trouvée (code 200) :

{
    "playerId": 2,
    "rate": true,
    "achievementSound": true,
    "scoreboard": true,
    "weather": "{time:true, weather:true}",
    "chestplate": "#FFFFFF"
}

⛔ Les erreurs

Les différents types d'erreurs :

Code HTTP	Description	Cause possible
400	Bad Request	Paramètres manquants ou invalides
401	Unauthorized	Clé API manquante ou invalide
403	Forbidden	Droits insuffisants pour utiliser la requête
404	Not found	Entité introuvable
500	Internal Server Error	Erreur interne du serveur

Attention !

En cas d'erreur 500, contactez directement Zeltaria avec votre requête, sa réponse ainsi que toutes informations que vous jugez pertinentes !

En cas d'erreur voici les informations que retourne l'API

Nom	Type	Description
code	number	Le code d'erreur que retourne la requête
message	string	Le message de l'API expliquant l'erreur

Exemple avec l'erreur 404 Not found :

Ici par exemple, l'erreur 404 signifie que le joueur n'a pas été trouvé dans la base de données.

{
    "message": "No value present",
    "code": 404
}