GET /player/get-player-by-nick

version 2.0.0

Récupère les informations d’un joueur à partir d'un de ses identifiants unique.

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
• Axel
• Site

🧾 Paramètres

Un seul de ces paramètres est requis (dans l'URL) pour identifier le joueur :

Nom	Type	Dans	Requis	Description	Valeur par default
nick	string	URL	✅	Le nickname a retrouver	❌

🧾 Réponse

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

Nom	Type	Nullable	Description
id	number	❌	L'ID du joueur sélectionné
pseudo	string	❌	Le pseudo du joueur sélectionné
credit	number	❌	Le nombre de crédits du joueur sélectionné
gradeId	number	❌	L'ID du grade du joueur sélectionné
modStatus	bool	❌	Si le joueur est en modérateur
staff	bool	❌	Si le joueur fait partie d'un des staffs
alert	bool	❌	S'il veut voir les messages réservés aux staffs
nickname	string	✅	Le surnom du joueur
status	string	❌	si le joueur est connecté au serveur
discordId	string	✅	Le discord ID s'il est relié
language	string	❌	La langue du joueur
streamerPoint	number	❌	Le nombre de point de stream du joueur
tag	string	✅	Le grade custom a afficher
color	string	✅	La couleur custom a utiliser
highclub	bool	❌	Si le joueur possède le highclub
vote	number	❌	Le nombre de points de vote

📤 Exemple de requête

Si je souhaite chercher les informations du joueur qui a le nickname Zelta voici ma requête :

http://0.0.0.0/api/player/get-player-by-nick?nick=Zelta

📥 Exemple de réponse

Voici le retour de l'API en fonction du résultat :

Si tout va bien et que le joueur est trouvé (code 200) :

{
    "id": 2,
    "pseudo": "Zeltaria",
    "credit": 0,
    "gradeId": 14,
    "modStatus": false,
    "staff": true,
    "alert": true,
    "nickname": "Zelta",
    "status": "Offline",
    "discordId": "213350119184138241",
    "langage": "FR",
    "streamerPoint": 0,
    "tag": null,
    "color": null,
    "highclub": true,
    "vote": 1
}

Information

Le joueur sera retourné si son nickname ou son pseudo correspond à la recherche !

⛔ 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
}