GET /player/get-full-players

version 2.0.0

Obtenir toutes les informations détaillées de plusieurs joueurs.

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 des paramètres est nécéssaire afin de choisir les joueurs à récupérer.

Nom	Type	Dans	Requis	Description	Valeur par default
ids	string	URL	⚠️	L'identifiant unique du joueur	❌
pseudos	string	URL	⚠️	Le pseudo du joueur	❌

attention

Vous ne pouvez pas utiliser les paramètres ids et pseudos en même temps.

🧾 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é
token	string	❌	Le token 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
firstConnection	string	❌	La première connection sous le format aaaa-mm-jjThh:mm:ssZ
totalTimeConnection	float	❌	Le temps passé sur le serveur
status	string	❌	si le joueur est connecté au serveur
ip	string	❌	L'ip du joueur
discordId	string	✅	Le discord ID s'il est relié
langage	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 d'id 2 voici ma requête :

http://0.0.0.0/api/player/get-full-players?ids=1,4

attention

Vous devez séparer les identifiants par une virgule.

📥 Exemple de réponse

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

[
    {
        "id": 1,
        "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,
        "vote": 1
    },
    {
        "id": 4,
        "pseudo": "axe1234567890689",
        "token": "axe1234567890689",
        "credit": 1000000,
        "gradeId": 10,
        "modStatus": false,
        "staff": true,
        "alert": false,
        "nickname": "axe",
        "firstConnection": "2024-01-01T10:00:00Z",
        "totalTimeConnection": 1.0,
        "status": "Offline",
        "ip": "1.2.3.4",
        "discordId": "314159265359",
        "langage": "FR",
        "streamerPoint": 0,
        "tag": null,
        "color": null,
        "highclub": true,
        "vote": 0
    }
]

info

Si aucun joueur n'est trouvé, l'API retourne un tableau vide.

⛔ 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
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 400 Bad Request :

Ici par exemple, l'erreur 400 signifie que la requête est mal formée, car il manque des paramètres requis.

{
    "message": "You must provide at least one parameter",
    "code": 400
}