Aller au contenu principal

GET /player/get-boosters

version 2.0.0

Récupère les informations des boosters 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 :

  • Zelta
  • Corail
  • Axel
  • Site

🧾 Paramètres

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

NomTypeDansRequisDescriptionValeur par default
playerIdstringURLL'identifiant unique du joueur

🧾 Réponse

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

NomTypeNullableDescription
playerIdnumberL'ID du joueur sélectionné
daily25numberCombien de boosters X0.25 a t-il
daily50numberCombien de boosters X0.5 a t-il
boosterX1numberCombien de boosters X1 a t-il
boosterX2numberCombien de boosters X2 a t-il
boosterX3numberCombien de boosters X3 a t-il
boosterX5numberCombien de boosters X5 a t-il
claimboolsi le joueur a récupérer ses boosters

📤 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-boosters?playerId=2

📥 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) :

{
"playerId": 2,
"daily25": 0,
"daily50": 0,
"boosterX1": 0,
"boosterX2": 0,
"boosterX3": 0,
"boosterX5": 0,
"claim": false
}

⛔ 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 playerId n'a pas été trouvé dans la base de données.

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