Aller au contenu principal

GET /player/get-full-player

version 2.0.0

Obtenir toutes les informations détaillées d’un 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
  • Site

🧾 Paramètres

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

NomTypeDansRequisDescriptionValeur par default
idstringURL⚠️L'identifiant unique du joueur
pseudostringURL⚠️Le pseudo du joueur
discordIdstringURL⚠️Le discordId du joueur
tokenstringURL⚠️Token unique du joueur (à éviter)

🧾 Réponse

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

NomTypeNullableDescription
idnumberL'ID du joueur sélectionné
pseudostringLe pseudo du joueur sélectionné
tokenstringLe token du joueur sélectionné
creditnumberLe nombre de crédits du joueur sélectionné
gradeIdnumberL'ID du grade du joueur sélectionné
modStatusboolSi le joueur est en modérateur
staffboolSi le joueur fait partie d'un des staffs
alertboolS'il veut voir les messages réservés aux staffs
nicknamestringLe surnom du joueur
firstConnectionstringLa première connection sous le format aaaa-mm-jjThh:mm:ssZ
totalTimeConnectionfloatLe temps passé sur le serveur
statusstringsi le joueur est connecté au serveur
ipstringL'ip du joueur
discordIdstringLe discord ID s'il est relié
langagestringLa langue du joueur
streamerPointnumberLe nombre de point de stream du joueur
tagstringLe grade custom a afficher
colorstringLa couleur custom a utiliser
highclubboolSi le joueur possède le highclub
votenumberLe nombre de points de vote

📤 Exemple de requête

Si je souhaite chercher les informations du joueur d'id 2 voici ma requête :

http://0.0.0.0/api/player/get-full-player?id=2

📥 Exemple de réponse

Si tout va bien (code 200), voici le retour attendu :

{
"id": 2,
"pseudo": "Zeltaria",
"token": "azerty123",
"credit": 0,
"gradeId": 14,
"modStatus": false,
"staff": true,
"alert": true,
"nickname": "Zelta",
"firstConnection": "2024-01-01T10:00:00Z",
"totalTimeConnection": 3600.0,
"status": "Offline",
"ip": "127.0.0.1",
"discordId": "213350119184138241",
"langage": "FR",
"streamerPoint": 0,
"tag": null,
"color": null,
"highclub": true
}

⛔ Les erreurs

Les différents types d'erreurs :

Code HTTPDescriptionCause possible
400Bad RequestParamètres manquants ou invalides
401UnauthorizedClé API manquante ou invalide
403ForbiddenDroits insuffisants pour utiliser la requête
404Not foundEntité introuvable
500Internal Server ErrorErreur 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

NomTypeDescription
codenumberLe code d'erreur que retourne la requête
messagestringLe 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
}