Aller au contenu principal

GET /minigame/get-all-players

version 2.0.0

Récupère les informations de tous les 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
  • Axel
  • Site

🧾 Paramètres

Aucun paramètre n'est requis pour cette requête.

🧾 Réponse

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

NomTypeNullableDescription
playerIdnumberL'ID du joueur sélectionné
dailyPrivatenumberLe nombre de ticket privé journalier
dailyOptionnumberLe nombre de ticket option journalier
ticketPrivatenumberLe nombre de ticket d'host privé
ticketOptionnumberLe nombre de ticket d'option
partyRequestboolSi le joueur accepte de recevoir des invitations de party

📤 Exemple de requête

Si je souhaite chercher les informations des joueurs voici ma requête :

http://0.0.0.0/api/minigame/get-all-players

📥 Exemple de réponse

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

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

[
{
"playerId": 8,
"dailyPrivate": 0,
"dailyOption": 0,
"ticketPrivate": 0,
"ticketOption": 0,
"partyRequest": true
},
{
"playerId": 43,
"dailyPrivate": 0,
"dailyOption": 0,
"ticketPrivate": 0,
"ticketOption": 0,
"partyRequest": true
}
]
info

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

⛔ 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
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 403 Forbidden :

Ici par exemple, l'erreur 403 signifie que vous n'avez pas les droits pour cette requête.

{
"message": "Access Denied",
"code": 403
}